v2.33
 
IRouteParams Interface Reference

The parameters of the route. More...

Inheritance diagram for IRouteParams:

Public Member Functions

HRESULT GetContour ([out, retval] ICurve3D **ppContour)
 Returns the contour of the route.
 
HRESULT GetFlowSegmentCount ([out, retval] int *pCount)
 Returns the number of flow segments (pipes, ducts, line electrical circuits) on the route.
 
HRESULT GetFlowSegmentPlacement (int index, [out, retval] IFlowSegmentPlacement **ppFlowSegmentPlacement)
 Gets the placement of a flow segment by the given index.
 
HRESULT GetJointCount ([out, retval] int *pCount)
 Returns the number of joints in the route.
 
HRESULT GetJointParams (int index, [out, retval] RouteJointParams *ppRouteJoint)
 Gets a joint by the given index.
 
HRESULT GetObjectOnRouteCount ([out, retval] int *pCount)
 Returns the number of objects (accessories, fittings) on the route.
 
HRESULT GetObjectOnRoutePlacement (int index, [out, retval] IObjectOnRoutePlacement **ppObjectOnRoutePlacement)
 Gets the placement of an object on the route by the given index.
 

Properties

int SourceModelObjectId [get]
 Returns the source model object identifier of the route.
 
int SourcePortIndex [get]
 Returns the port index of the source object to which the route is connected. If the source object is a Route, then -1 is returned.
 
int SystemStyleId [get]
 Returns the system style id.
 
int TargetModelObjectId [get]
 Returns the target model object identifier of the route.
 
int TargetPortIndex [get]
 Returns the port index of the target object to which the route is connected. If the target object is a Route, then -1 is returned.
 

Detailed Description

The parameters of the route.