Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » NodeSelector |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AddInfo | Configures the <NodeSelector> object to form relationships with from the <Node> in which the <NodeSelector> is resident, and one or more <Node> objects in the same document ( or different documents ). For example, the expression 'DataIn.attributes.position' refers to three separate <Node> objects. 'DataIn' refers to an <InterfaceBlockNode>, 'attributes' refers to a <StructInstanceNode>, and 'position' refers to a <Float32VectorNode>. These <Node> objects may be in one or more documents, and this function configures the <NodeSelector> object to refer to these <Node> objects in order to form an expression. This function uses three container object parameters, a <List> object, an <Int32Array> object, and a <StrList> object. This function will not perform any work if the number of items in the container objects are not equal, or if the <Node> object parameter is not resident in a document ( via Model.AddNode() ) that has been saved at least once. |
| int32 | AddNode | Configures the <NodeSelector> object to form a relationship with a single <Node>. |
| int32 | ChangeModel | Changes the root Model referred to by a <NodeSelector> object. The <NodeSelector> object uses the root Model to resolve relative paths, so it's important to only use this data interface if you know what you're doing. It's worth noting that there are very few cases where this function should ever be used, but you can look at CREATE_TEMPLATE_SCRIPTS.SSL for examples. |
| int32 | Clear | Clears the <NodeSelector> object's underlying data members, which includes the <NodeList> object that stores references to <Node> objects, the <Int32Array> object that stores array sizes, the <Int32Array> object that stores array indices, and the <StrList> object that stores code object names. The count of these objects becomes zero, and the memory used by these objects is released. |
| int32 | GetAllLinks | Populates a <NodeBuffer> object with any <NodeLink> objects currently managed by this <NodeSelector> object. Most of these <NodeLink> nodes are resident in the <NodeSelector> object's NameSpaceLinks <List> object. |
| int32 | GetInfo | Populates objects with references to the data managed the <NodeSelector>. |
| <NodeLink> | GetLink | Returns a pointer to a <NodeLink> at the specified index. |
| <Node> | GetVariable | Returns a pointer to the last object in the <List> of objects managed by the <NodeSelector>. |
| string | GetVariableName | If the last <Node> in the <List> of <Node> objects managed by the <NodeSelector> object is derived from <VariableNode>, this function returns by value a string containing the complete variable name. Otherwise returns by value a blank string. |
| int32 | ValidateCount | Returns non-zero if the count of the <NodeSelector> object's <NodeList>, <Int32Array>, and <StrList> objects are equal. Returns 0 if the counts are not equal. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <Int32Array> | ArrayElements | Returns a pointer to the <NodeSelector> object's underlying <Int32Array> object that stores array indices. For example, in the expression int i = intArray[3], the value 3 is stored by this <Int32Array>. This data member provides very low-level access to the <NodeSelector> object and should only be used if safer helper function such as AddInfo() and AddNode() are not suitable. |
| <Int32Array> | ArraySizes | Returns a pointer to the <NodeSelector> object's underlying <Int32Array> object that stores array sizes. For example, in the expression int a_iArray[2] = int[2]( 0, 1 ), the value 2 is stored by this <Int32Array>. This data member provides very low-level access to the <NodeSelector> object and should only be used if safer helper function such as AddInfo() and AddNode() are not suitable. |
| <StrList> | CodeObjectNames | Returns a pointer to the <NodeSelector> object's underlying <StrList> object that stores code object names. For example, in the expression int i = intArray[3], 'i' and 'intArray' are examples of data stored by this object. This data member provides very low-level access to the <NodeSelector> object and should only be used if safer helper function such as AddInfo() and AddNode() are not suitable. |
| <Node> | Container | This option is undocumented at present. |
| <Node> | ContainerLink | This option is undocumented at present. |
| <NodeList> | NamespaceLinks | Returns a pointer to the <NodeSelector> object's underlying <NodeList> object that stores a <List> of <Node> objects managed by the <NodeSelector>. For example, the expression 'DataIn.attributes.position' refers to three separate <Node> objects. 'DataIn' refers to an <InterfaceBlockNode>, 'attributes' refers to a <StructInstanceNode>, and 'position' refers to a <VectorNode>. The <NodeSelector> object's <NodeList> object stores <NodeLink> objects that point at these <Node> objects. This data member provides very low-level access to the <NodeSelector> object and should only be used if safer helper function such as AddInfo() and AddNode() are not suitable. |