All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATArrangementInterfaces Interface CATIArrSegmentsString

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIArrSegmentsString
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIArrSegmentsString

Interface on a Segment .
Role: To get the segment data, corresponding nodes.


Method Index


o GetEndPoints(CATIArrNode_var&,CATIArrNode_var&)
Retrieve the extremity nodes of the string element.
o GetMinLen(double&)
GetMinLen.
o GetNominalSize(CATUnicodeString&)
GetNominalSize.
o GetSection(CATIRouSection_var&)
Get Section.
o GetStringLength(CATIMovable_var&,double&)
Get the total length of the string.
o ListNodes(CATListValCATBaseUnknown_var&)
Return a list of Nodes.
o ListSegments(CATListValCATBaseUnknown_var&)
Return a list of Segments.

Methods


o GetEndPoints
public virtual HRESULT GetEndPoints(CATIArrNode_var& ohEndPoint1,
CATIArrNode_var& ohEndPoint2)= 0
Retrieve the extremity nodes of the string element.
Parameters:
ohEndPoint1
Beginning node of a string element.
ohEndPoint2
Ending node of a string element.
o GetMinLen
public virtual HRESULT GetMinLen(double& oMinLen)= 0
GetMinLen.
Parameters:
oMinLen
Return the minimum straight length on a run.
o GetNominalSize
public virtual HRESULT GetNominalSize(CATUnicodeString& oSize)= 0
GetNominalSize.
Parameters:
iSize
Return the nominal size fo the SegmentString.
o GetSection
public virtual HRESULT GetSection(CATIRouSection_var& oSection)= 0
Get Section.
Parameters:
oSection
CATIRouSection_var.
Returns:
HRESULT.
o GetStringLength
public virtual HRESULT GetStringLength( const CATIMovable_var& iRelAxis,
double& oLength)= 0
Get the total length of the string.
Parameters:
iRelAxis
Reference Axis.
o ListNodes
public virtual HRESULT ListNodes(CATListValCATBaseUnknown_var& oListOfNodes)= 0
Return a list of Nodes.
Parameters:
oListOfNodes
CATListValCATBaseUnknown_var.
Returns:
HRESULT.
o ListSegments
public virtual HRESULT ListSegments(CATListValCATBaseUnknown_var& oListOfSegments)= 0
Return a list of Segments.
Parameters:
oListOfSegments
CATListValCATBaseUnknown_var.
Returns:
HRESULT.

This object is included in the file: CATIArrSegmentsString.h
If needed, your Imakefile.mk should include the module: CATArrangementItf

Copyright © 2003, Dassault Systèmes. All rights reserved.