<RelationshipNode> Data Interface

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

Class HierarchyType » Node » Group » RelationshipNode

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32CompareCompares p_oRelationshipNodeB with this <RelationshipNode>. Returns true if the <RelationshipNode> objects match exactly. Otherwise returns false.
int32CompareReferencesCompares references from two sets of <RelationshipNode> objects and populates the destination <NodeBuffer> with any that have changed.
int32CompareSetCompares sets of <RelationshipNode> objects ( each set must be contained in a <Group>-derived <Node> ) and populates the <List> object with pointers to the <RelationshipNode> objects in set A that do not match any <RelationshipNode> objects in set B. This function is highly-optimized to compare large sets of <RelationshipNode> objects. For example, you create a document and store its dependencies and references with <RelationshipNode> objects. Later you make changes to the document. This allows you to compare the old dependencies and references with the new dependencies and references to see what's changed.
int32CopyParamsCopies the params from the source <RelationshipNode> onto this <RelationshipNode>.
int32CreateDependenciesPopulates the <Group> submitted to this function with <RelationshipNode> objects created from information in the <StrList> submitted to this function.
<Str>GetDestinationFilePathAbsReturns a string containing the absolute path to the destination document.
int32GetInfoPopulates a <StrList> with dependency and reference information strings gathered from the <NodePtrArray> submitted to this function. This can easily be done with pure SSL ( which means you don't need to use this function ), but there could be cases ( for large sets ) where performance is extremely important.
<Str>GetSourceFilePathAbsReturns a string containing the absolute path to the source document.
stringResolveDestinationFilePathResolves a relative destination file path using the destination file path folder resolution value. ( .DestinationFolderResolution ).
stringResolveSourceFilePathResolves a relative source file path using the source file path folder resolution value. ( .SourceFolderResolution ).
int32SetDstDataSets the destination data using the <Node> submitted to this function.
int32SetSrcDataSets the source data using the <Node> submitted to this function.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
TypeInformationDestinationNodeTypeGets or sets the destination <Node> type. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the type of NodeB. The type can be obtained by calling NodeB.GetType().GetTypeName().
<StrList>NodeStringParamsReturns a pointer to this object's underlying generic string parameters <StrList> object. Use cases for this object are implementation defined.
TypeInformationSourceNodeTypeGets or sets the source <Node> type. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the type of NodeA. The type can be obtained by calling NodeA.GetType().GetTypeName().
int32DependencyOriginationGets or sets the dependency origination flag. This value refers to the DependencyOrigination enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. You must know the dependency origination in order to set this value correctly, but DEPENDENCY_UTIL.SSL has several examples.
stringDestinationFilePathGets or sets the destination file path. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, the filename of the document containing NodeB is the destination file path. The destination file path can be obtained by calling NodeB.GetModel().Filename. The path can be absolute or relative depending on your use case. In most Scenome applications, the destination file path will start out absolute and then be made relative to a document inside \CONTENT\DEPENDENCIES or CONTENT\REFERENCES.
int32DestinationFolderResolutionSets the base path to use to resolve the destination file path. This refers to the FolderResolution enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information.
stringDestinationNodeGuidGets or sets the destination <Node> GUID. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the GUID of NodeB. The destination GUID can be obtained by calling NodeB.GetGuid().Value.
stringDestinationNodePathGets or sets the destination <Node> path. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the graph address of NodeB. The graph address can be obtained by calling NodeB.GetPathToNode().
int32DestinationNodePositionGets or sets the destination <Node> position, which is the distance from the root to the <Node>. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the graph position of NodeB. The <Node> position can be obtained by calling NodeB.GetDistanceFromRoot().
stringSourceFilePathGets or sets the source file path. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, the filename of the document containing NodeA is the source file path. The source file path can be obtained by calling NodeA.GetModel().Filename. The path can be absolute or relative depending on your use case. In most Scenome applications, the source file path will start out absolute and then be made relative to a document inside \CONTENT\DEPENDENCIES or CONTENT\REFERENCES.
int32SourceFolderResolutionSets the base path to use to resolve the source file path. This refers to the FolderResolution enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information.
stringSourceNodeGuidGets or sets the source <Node> GUID. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the GUID of NodeA. The source GUID can be obtained by calling NodeA.GetGuid().Value.
stringSourceNodePathGets or sets the source <Node> path. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the graph address of NodeA. The graph address can be obtained by calling NodeA.GetPathToNode().
int32SourceNodePositionGets or sets the source <Node> position, which is the distance from the root to the <Node>. Given two <Node> objects, NodeA and NodeB, where NodeA points at NodeB, this value stores the graph position of NodeA. The <Node> position can be obtained by calling NodeA.GetDistanceFromRoot().