ElecHarnessItf Interface CATIEhiSegment
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiSegment
Interface to manage a segment.
Role:A segment is a subdivision of a branch.
Method Index
- o
ComputeMinimumBendRadius(double&)
- Compute the minimum bend radius of a segment.
- o
GetBranch(CATIEhiBranch**)
- Retreive the branch from the segment.
- o
GetEnds(CATIEhiSegmentEnd**,CATIEhiSegmentEnd**)
- Retrieve segment ends ( connector points ).
- o
GetGeometry(CATBody**)
- Retrieves the topology of Segment geometry.
- o
GetSupportPosition(CATIEhiSegmentEnd*,CATBaseUnknown*,double&,double&)
- Compute distances between a segment end and input/output point of a support.
- o
ListProtectiveCovering(CATListValCATBaseUnknown_var**)
- Retrieves the list of Protective Coverings on the Segment.
- o
ListSupports(CATListValCATBaseUnknown_var**)
- Compute the ordered list of the supports totally or partially included in the segment route.
Methods
o ComputeMinimumBendRadius
| public virtual ComputeMinimumBendRadius( | | oBendRadius) |
-
Compute the minimum bend radius of a segment.
- Parameters:
-
- oBendRadius
- computed bend radius of segment.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while Computing bend redius.
o GetBranch
| public virtual GetBranch( | | opBranch) |
-
Retreive the branch from the segment.
- Parameters:
-
- opBranch
- The branch
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while adding support.
o GetEnds
| public virtual GetEnds( | | opBnlSegmentExt1, |
| | opBnlSegmentExt2) |
-
Retrieve segment ends ( connector points ).
- Parameters:
-
- opBnlSegmentExt1
- connector point at end 1.
- opBnlSegmentExt2
- connector point at end 2.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- The segment representation does not exist.
o GetGeometry
| public virtual GetGeometry( | | opBodySegment) |
-
Retrieves the topology of Segment geometry.
- Parameters:
-
- opBodySegment
- the Body of Segment geometry.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o GetSupportPosition
| public virtual GetSupportPosition( | | ipISegmentEnd, |
| | ipUnkSupport, |
| | odistance_input, |
| | odistance_output) |
-
Compute distances between a segment end and input/output point of a support.
- Parameters:
-
- ipISegmentEnd
- an end of segment.
- ipSupport
- a support of segment.
- odistance_input
- curvilinear distance from the end to support input point ( MKS unit ), =0 if support input point is outside segment limits.
- odistance_output
- curvilinear distance from the end to support input point ( MKS unit ), =0 if support ouptut point is outside segment limits.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while computing distances.
o ListProtectiveCovering
| public virtual ListProtectiveCovering( | | oListOfProtectiveCoverings) |
-
Retrieves the list of Protective Coverings on the Segment.
- Parameters:
-
- oListOfProtectiveCoverings
- the list of Protective Coverings on this Branch,NULL if NO coverings present..
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o ListSupports
| public virtual ListSupports( | | opSupportList) |
-
Compute the ordered list of the supports totally or partially included in the segment route.
- Parameters:
-
- opSupportList
- List of supports on segment.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while listing supports.
This object is included in the file: CATIEhiSegment.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.