<ConnectorNode> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » Node » Group » ConnectorNode

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32AddConnectionForms a connection between this object and another <Node> in the same document.
int32AddTypeRuleAdds a rule to this object. A rule consists of a <TypeInformation> pointer and a Boolean value that indicates whether or not the rule requires an exact match.
int32ClearClears the underlying <TypeInfoArray>, <Int32Array>, and <NodeSink> objects that define rules, match criteria, and connections.
int32ClearAllConnectionsDestroys all connections formed by this <ConnectorNode>. Visibly 'disconnects' the wires that connect two or more <WorkflowNode> graphlets. Unlike Clear, this does not destroy all the type rules.
int32GetConnectedNodesPopulates a <NodeBuffer> object with non-owning pointers to all the node object's of the specified type to which this <ConnectorNode> is connected.
int32GetConnectionCountReturns an <int32> representing the number of connections from this <Node> to other node object's in the document.
<Node>GetConnectionNodeReturns a pointer to the <Node> at the specified index to which this <Node> is connected.
int32GetConnectionValueReturns an <int32> representing the index value of the connection at the specified index.
int32GetCountReturns the count of the underlying <TypeInfoArray> and <Int32Array>. Returns 0 if the count of these objects is not the same.
int32GetDataSourceIndicesPopulates the <Int32Array> submitted to this function with the indices of the <Node> submitted to this function. For example: if you wish to find the indices that this <Node> uses to store pointers to the queried <Node>.
int32GetDstConnectorsPopulates a <NodeBuffer> with any <ConnectorNode> objects to which this <ConnectorNode> is connected. ( <ConnectorNode> objects this <Node> points at. )
<Node>GetFirstConnectionNodeReturns a pointer to the first <Node> to which this <ConnectorNode> is connected.
<Node>GetFirstNodeReturns a pointer to the first <Node> to which this <ConnectorNode> is connected. Same as GetFirstConnectionNode, but with shorter syntax.
int32GetMatchCriteriaReturns an <int32> where 0 indicates that a subclass match is acceptable, and 1 indicates that an exact match is required.
int32GetSrcConnectorsPopulates a <NodeBuffer> with any <ConnectorNode> objects that point at this <ConnectorNode>.
TypeInformationGetTypeRuleReturns a <TypeInformation> pointer that indicates the <Node> type component of the rule.
int32HasConnectedNodesReturns true if this <ConnectorNode> is connected to any other node object's.
int32RemoveConnectionRemoves the connection between this <ConnectorNode> and the <Node> at the specified index.
int32RemoveConnectionsDestroys connections in this <Node> for all index values in the <Int32Array> submitted to this function.
int32RemoveTypeRuleRemoves the rule ( the <TypeInformation> value and the match criteria value ) at the specified index. Returns 1 if the removal succeeds; otherwise returns 0.
int32ValidateCountsReturns true if the underlying <TypeInfoArray> and <Int32Array> objects ( that store the type rules and match criteria ) have the same count. In normal operation, these objects will always the same count, but it is possible for bugs or other forms of incorrect code to result in mismatches to their respective counts.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
<Node>TargetDataSourceGets or sets a pointer to the <ConnectorNode> object's data source.
<Node>TargetDataSourceLinkGets or sets a pointer to the <ConnectorNode> object's target data source. If the target data source is a <NodeLink>, this function returns the <Node> pointed at by the <NodeLink>.
<TypeInfoArray>TypeDataReturns a pointer to this object's internal <TypeInfoArray>.
int32AddChildGets or sets the Boolean flag that determines whether or not a <ConnectorNode> represents a parent/child relationship. Generally this feature is used to convert <WorkflowNode> document layouts to standard .BOX file hierarchies, but there may be other uses as well.
int32AllowNullConnectionGets or sets this flag. This is mostly an application flag, and different applications will use and interpret this flag differently. For example: in the <Image> app, this flag allows validation to proceed even if the <ConnectorNode> is not connected to anything.
int32ExclusiveGets or sets the Boolean flag that determines whether or not this <Node> object's connection is exclusive. A <ConnectorNode> with an exclusive connection causes all other <ConnectorNode> objects to be cleared when it acquires a connection.
int32MaxConnectionCountGets or sets the maximum number of connections that this <ConnectorNode> can formed.
stringOnValidateFunctionThe string of an Scenome Scripting Language function to call to validate the connection. Note that at present no Scenome applications use this parameter during <WorkflowNode> processing.
stringValidateFilePathGets or sets the absolute or relative path to a .SSL script file that contains the implementation of the connection validation function.