Function Name: Get Number Of Paths To Transmittal Root

Definition

Determines how many different paths can be traversed from the Transmittal Root to the given object, where a path is defined as a bidirectional aggregate to component relationship. Feature Nodes / Geometry Nodes and Feature Edges / Geometry Edges are handled differently. For these objects, the number of paths is derived from specific DRM relationships.

If object_in, or any of the objects between it and its Transmittal Root, are referenced as a component from another transmittal and that transmittal is open, then the paths counted are those to the other transmittal's Transmittal Root. Otherwise, the paths are to the Transmittal Root within object_in's own transmittal.

To get the number of paths for

  1. a Feature Edge

  2. a Geometry Edge

  3. a Feature Node

  4. a Geometry Node

Returns

SE_SUCCESS - if valid parameters were passed in.

SE_NULL_REQUIRED_PARAMETER - if number_of_paths_out_ptr is NULL. In this case, *number_of_paths_out_ptr is set to 0.

SE_INVALID_OR_NULL_OBJECT - if object_in is not a handle to a valid SEDRIS object. In this case, *number_of_paths_out_ptr is set to 0.

SE_UNRESOLVED_START_OBJECT - if object_in is unresolved. In this case, *number_of_paths_out_ptr is set to 0.

SE_FAILURE - and *number_of_paths_out_ptr is set to 0, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetNumberOfPathsToTransmittalRoot
(
SE_OBJECT object_in, (notes)
SE_UINT32 *number_of_paths_out_ptr (notes)
);

Parameters Notes

object_in

 a SEDRIS object.

number_of_paths_out_ptr

 a pointer to an SE_UINT32 variable in the user's
    memory space where the number of paths will be stored.

Prev: Get Nth Component Of Given Type. Next: Get Object For ID. Up:Index.