All Frameworks Class Hierarchy This Framework Indexes
ElecDeviceItf Interface CATIElbSupport
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIElbSupport
This interface allows user to retrieve the information of the Support
This interface is implemeneted on Electrical Support.
Method Index
- o
GetNumberOfSections(int&)
- Get the number of sections in support.
- o
ListSegments(CATListValCATBaseUnknown_var**,int,CATListOfDouble**,CATListOfDouble**)
- List the Segments routed through section "iSectionNumber" of a multi-sectional support.
- o
SetSegmentPositions(CATListValCATBaseUnknown_var*,CATListOfDouble*,CATListOfDouble*,int)
- Sets U and V of List the Segments routed through a particular section of a multi-sectional support.
Methods
o GetNumberOfSections
| public virtual GetNumberOfSections( | | oNbSections) |
-
Get the number of sections in support.
- Parameters:
-
- oNbSections
- oNbSections is updated with Number of sections.
- Returns:
- Return code S_OK if oNbSections is correctly retrieved
E_FAIL if oNbSections cannot be retrieved.
o ListSegments
| public virtual ListSegments( | | oppListOfSegments, |
| | iSectionNumber | = 1, |
| | oppListOfSegmentU | = NULL, |
| | oppListOfSegmentV | = NULL) |
-
List the Segments routed through section "iSectionNumber" of a multi-sectional support.
This function also list all U and V positional values of segments on one to one mapping basis.
.i.e. first elements of "oppListOfSegmentU" and "oppListOfSegmentV" will correspond to U and V of first segment in "opListOfSegments"
- Parameters:
-
- oppListOfSegments
- This List is updated with segments passing through section specified by "iSectionNumber".
- iSectionNumber
- section number through which list routed segments along with their U and V is required
section number starts from 1.
- oppListOfSegmentU
- This list is updated with U values corresponding to segments updated in list "oppListOfSegments".
First element in this list corresponds to U value of first segment in list "oppListOfSegments"
- oppListOfSegmentU
- This list is updated with V values corresponding to segments updated in list "oppListOfSegments".
First element in this list corresponds to V value of first segment in list "oppListOfSegments"
- Returns:
- Return code S_OK if oppListOfSegments is correctly retrieved.
S_FALSE with oppListOfSegments->Size() = 0 when no Segments routed through section.
E_FAIL if oppListOfSegments cannot be retrieved.
o SetSegmentPositions
| public virtual SetSegmentPositions( | | ipListOfSegments, |
| | ipListOfSegmentU, |
| | ipListOfSegmentV, |
| | iSectionNumber | = 1) |
-
Sets U and V of List the Segments routed through a particular section of a multi-sectional support.
There must be one to one mapping between elements of Lists "ipListOfSegments", "ipListOfSegmentU" and
"ipListOfSegmentV"
i.e U value of first element in List "ipListOfSegments" = value of first element in List :ipListOfSegmentU"
V value of first element in List "ipListOfSegments" = value of first element in List :ipListOfSegmentV"
U value of second element in List "ipListOfSegments" = value of second element in List :ipListOfSegmentU"
V value of second element in List "ipListOfSegments" = value of second element in List :ipListOfSegmentV"
and so on.....
- Parameters:
-
- ipListOfSegments
- Contains List segments routed through section specified by "iSectionNumber".
- ipListOfSegmentU
- Contains U values of segments in list "ipListOfSegments".
- ipListOfSegmentV
- Contains V values of segments in list "ipListOfSegments".
- iSectionNumber
- section number through which segments specified by list of segments "ipListOfSegments" are routed
section number starts from 1.
- Returns:
- Return code S_OK if Segment Positions are correctly set.
E_FAIL if Segment Positions cannot be set.
This object is included in the file: CATIElbSupport.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces