IGH_Param Interface

Gets or sets the Access level for this parameter.

Gets or sets the data mapping of this Parameter.

Gets the type of the current data state.

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 this object is capable of emitting data.

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

Gets or sets the locked flag of this object. Locked 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 whether or not this parameter is considered optional by the owner component. Empty, non-optional parameters prevent the component from being solved.

Gets the solution phase in which this object is currently stuck.

Gets the most recent measured processor time.

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.

Gets the worst-case level of all messages. I.e. if only warnings have been recorded, the level will be ::warning. If even a single error exists, the level will be ::error.

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 the Framework Type descriptor for the stored Data.

Gets a human readable description of the data stored in this parameter.

Gets the instance of the volatile data tree stored in this parameter.

Gets the total number of volatile data items stored in this parameter.

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

Add a new message to this object. Valid message type flags are Warning and Error. If the Message string is empty or zero-length no message is added.

Append a new Source parameter to the end of the Sources list. Sources provide this parameter with data at runtime.

Insert a new Source parameter into the Sources list. Sources provide this parameter with data at runtime.

Inserts an item of volatile data into the data structure.

Inserts a list of items into the data structure.

Insert an entire data tree into this parameter.

This function is called whenever the object needs to clear all solution data. This usually amounts to wiping volatile caches and messages. This function will not affect any other objects, but it will set the Phase flag to Blank

Remove all proxy sources without attempting to relink them.

Clear all message lists.

This function is called whenever the object is required to collect all data. Either from Persistent records, from source params or whatever. This step is only performed if the phase flag is Blank or Failed. Upon completion, the phase flag will be set to Collected

This function is called whenever the object is required to generate new data. This step is only performed by some objects and only when the Phase flag is Collected. Upon completion, the Phase will be Computed. If this object throws exceptions, it is the responsibility of the caller to set the Phase flag to Failed.

Convert all proper source parameters into proxy sources.

Solve the inheritance relationship between this object and a potential parental object.

If this object depends on Rhino Objects, you must register the UUIDs of those objects. Failure to do so will result in faulty event handling.

Attempt to replace all proxy sources with real 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.

Remove all sources from this parameter.

Remove all post-process effects.

Remove the specified source from this parameter.

Remove the specified source from this parameter.

Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.

Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.

Gets the list of cached runtime messages that were recorded during solver-time processes.

Test whether this object is compliant with a given Rhino version.