IGH_ProxyParameter

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 the current data state.

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.

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.

Gets the current display mode of the object.

Gets a description of the current state of the object. This field is usually the same as the Description() field, but it might be variable when overridden.

Gets the ID of this runtime instance.

Gets whether or not this object is capable of emitting data.

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 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 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.

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 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 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.

This method will be called when an object is added to a document.

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.

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

Append a new Source parameter to the end of 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 when a context menu is about to be displayed. Override it to set custom items.

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.

Create new default attributes for this object. You should only call this function when the Attributes() field is null.

Convert all proper source parameters into proxy sources.

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

This method will be called when the document that owns this object moves into a different context.

Call this function when you suspect that the preview has expired for this object. This will cause the display cache to be eradicated.

Call this function whenever you do something which expires the current solution. This will make sure all caches are erased, all downstream objects are expired and that the event is raised. The default implementation merely places a call to OnSolutionExpired(), override this function in derived classes to make sure you clear local data caches and expire downstream objects.

Destroy all connections to other objects.

This method will be called when an object is moved from one document to another.

Generate a new random instance GUID

Set the instance ID to be a specific GUID. This is very dangerous, only use this function if you're 6"4' and called David.

Raises the AttributesChanged event on the toplevel object.

Raises the DisplayExpired event on the toplevel object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raise the PingDocument Event on the toplevel object and try to find the document which owns this object.

Raises the PreviewExpired event on the toplevel object.

Raises the SolutionExpired event on the toplevel object.

This method is called whenever the instance is required to deserialize itself.

Record a specific object change undo event.

Record a generic object change undo event.

Record an entire undo record.

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.

This method will be called when an object is removed from a document.

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.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

Triggers the AutoSave function on the owner document with a custom flag.

Triggers the AutoSave function on the owner document with the object_changed flag.

This method is called whenever the instance is required to serialize itself.

Raised whenever the number or kind of attributes changes. This event is handled by GH_Documents who subsequently wipe their attribute caches.

Raised whenever the display (on the Canvas) of a certain object becomes invalid.

Raised whenever some property of the object changes that would affect remote instances.

Raised whenever an object needs to know which GH_Document it belongs to.

Raised whenever the display (in the Rhino viewports) of a certain object becomes invalid.

Raised whenever the solution of a certain object becomes invalid.