GH_PersistentReferenceParamT Properties

Gets or sets the Access level for this parameter.

Gets or sets the attributes that are associated with this object. Only set custom attributes if you know what you are doing.

Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.

Returns a consistent ID for this object type. Every object must supply a unique and unchanging ID that is used to identify objects of the same type.

Gets or sets the data mapping of this Parameter.

Gets the type of data stored in this parameter.

Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.

Gets the exposure of this object in the Graphical User Interface. The default is to expose everywhere.

Gets whether or not the Category field has been set.

Gets a value indicating whether or not this parameter maintains proxy sources. Proxy sources are used during file IO, when actual sources might not be available yet. Once an IO operation has been completed there should be no more proxy sources.

Gets whether or not the SubCategory field has been set.

The icon associated with this object.

The greyscale icon of this object.

By default the NickName menu item supports the Icon Mode override toggle. If your UI is not capable of displaying icons, then override this property and return False.

Gets the current display mode of the object.

Gets the description of this instance. The default description is about the amount and source of the local values.

Gets the ID of this runtime instance.

Gets whether this parameter is a principal parameter. Principal parameters are maintained by components and are not part of the IGH_Param interface.

Gets a list of additional keywords that describe the object. Typically this list is empty but you can override this property to aid in object searches.

Gets the parameter kind. The kind is evaluated lazily and cached.

Gets or sets the enabled flag of this object. Disabled objects are ignored during solutions.

Gets or sets a value that enables Nick name changes through the menu. The default is TRUE.

Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.

Gets or sets the nickname of the object. This field can be changed by the user.

Gets whether this object is obsolete. Default implementation returns true if the class name contains the string "OBSOLETE" or if this class has been decorated with the ObsoleteAttribute. You are free to override this if you want, but I suggest adding the ObsoleteAttribute instead.

Gets or sets whether or not this parameter is considered optional by the owner component. Empty, non-optional parameters prevent the component from being solved.

Gets the persistent data stored in this parameter. If you modify the persistent data, be sure to call the: OnObjectChanged(GH_ObjectEventType.PersistentData) event.

Gets the number of persistent data items stored in this parameter.

Gets or sets the solution phase this object is currenly in.

Gets the number of proxy sources for this parameter. Proxy sources are used during file IO, when actual sources might not be available yet. Once an IO operation has been completed there should be no more proxy sources.

Gets a list of all the recipients of this parameter. I.e. a recipient has this parameter as one of the sources. The Recipient list is maintained by the parameter, do not modify it yourself.

Gets or sets the data reverse modifier of this parameter.

Returns the worst case flag for the current object

If the object contains at least 1 error, the result is Error.

If the object contains at least 1 warning, the result is Warning.

If the object contains at least 1 message, the result is Remark.

If the object contains no errors, no warnings and no messages, the result is Blank.

Gets or sets the simplify modifier for this parameter.

Gets the number of sources for this parameter.

Gets a list of source parameters. Do not modify this list, if you wish to add or remove sources, use dedicated functions like AddSource() and RemoveSource() instead.

Gets all the StateTags that are associated with this parameter. A state tag is a visual feedback icon that represents specific internal settings.

Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.

Gets the Framework Type descriptor for the stored Data.

Gets or sets the wire display style for this parameter. Wire display only affects the wires connected to the parameter input.