ElecDeviceItf Interface CATIElbSupportInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIElbSupportInstance
Method Index
- o
GetNumberOfSections(int&)
- Gets the number of support sections.
- o
ListAllSegments(CATLISTP_CATEhiSegmentInfo*&)
- Gets the list of segments passing through the support through All sections.
- o
ListSegmentsThroughSection(CATLISTP_CATEhiSegmentInfo*&,int)
- Gets the list of segments passing through the support through specified section.
- o
SetSegmentPositions(CATLISTP_CATEhiSegmentInfo*,int)
- Sets the segment position in branch route.
Methods
o GetNumberOfSections
| public virtual GetNumberOfSections( | | oNbSections) |
-
Gets the number of support sections.
- Parameters:
-
- oNbSections
- Number of support sections.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while getting the Number of sections.
o ListAllSegments
| public virtual ListAllSegments( | | opListOfSegmentsPassingThroughSupport) |
-
Gets the list of segments passing through the support through All sections.
- Parameters:
-
- opListOfSegmentsPassingThroughSupport
- Output list of segments passing through the support through All sections.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while getting segments.
- E_INVALIDARG
- Input List not empty
o ListSegmentsThroughSection
| public virtual ListSegmentsThroughSection( | | opListOfSegmentsPassingThroughSection, |
| | iSectionNumber | = 1 ) |
-
Gets the list of segments passing through the support through specified section.
Note :- if no section is specified it will return the segments passing through sec 1
- Parameters:
-
- opListOfSegmentsPassingThroughSection
- Output list of segments passing through the support through specified section.
- iSectionNumber
- section from which list of segments passing through the support are required.
Note :-If not specified iSectionNumber value then segments through Section 1 are returned.
- Returns:
-
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while getting segments.
- E_INVALIDARG
- Input List not empty
o SetSegmentPositions
| public virtual SetSegmentPositions( | | ipListOfSegmentsThroughSection, |
| | iSectionNumber | = 0) |
-
Sets the segment position in branch route.
- Parameters:
-
- ipListOfSegmentsThroughSection
- Input list of segments for which positions are to be set.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while setting the segment positions.
- E_INVALIDARG
- Invalid input values
This object is included in the file: CATIElbSupportInstance.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.