GH_TaskCapableComponentT Properties

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.

Gets the clipping box for all preview geometry drawn by this component and all associated parameters.

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 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 whether or not the SubCategory field has been set.

Override this method if you want the help topic content to be more than the Component description.

Gets or sets the hidden flag for this component. Does not affect Hidden flags on parameters associated with this component.

Override this function to supply a custom icon (24x24 pixels). The result of this property is cached, so don't worry if icon retrieval is not very fast.

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 constructor flag for this instance. If InConstructor = True, it means the component is still registering parameters and the layout is not yet complete.

Is set to True by the framework right before a "use tasks" pass is made on SolveIntance calls. When True, SolveInstance should be using Tasks to start calculations on input data. When False, SolveInstance should be setting the output data by either using the result of a task or directly computing the results.

Gets the ID of this runtime instance.

Components are never Data providers. Only the output parameters can be considered to be providers.

If a single parameter is PreviewCapable, so is the component. Override this property if you need special Preview flags.

Gets whether the MasterParameterIndex property identifies a valid parameter.

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 or sets the Locked state for this Component. This also sets locked states for all input and output parameters.

Gets or sets a custom message to be displayed underneath the component. This message is not serialized and should be assigned on every solution anew.

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 the parameter manager object for this component.

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

Gets or sets the principal parameter index override. Negative indices or indices larger than or equal to the input parameter count will be ignored and regular principal parameter detection will kick in.

Gets the total processor time (profiler) spend by this component and all input parameters.

Gets a value indicating how many times the SolveInstance method was called on this component during the last solution. This property will return -1 if no valid runcount is available.

Returns the worst case runtime warning level of me and all my parameters

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

Returns True if the component is set to support tasks. Components can have this feature turned on/off. Note that even if UseTasks returns True, there is a chance that a multipass task based solution may not be invoked depending on if multiple calls need to be made during enumeration. You must pay attention to the value of InPreSolve during SolveInstance. The set version of this property can be called by the framework if we want to provide a technique to globally turn on/off task support for all components in a definition.