ElecHarnessItf Interface CATIEhiBranch
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiBranch
Interface to manage a branch .
Role:A branch is a group of segments.
Method Index
- o
GetBendRadius(double&)
- Method to get the Bend Radius of the Branch.
- o
GetCreationMode(CATUnicodeString&)
- Method to get build method used to compute the branch.
- o
GetHarnessBundle(CATBaseUnknown**)
- Retrieves the harness bundle of the branch.
- o
GetLength(double&)
- Method to retreive the Branch length.
- o
GetRouteGeometry(CATBody**)
- Retrieves the topology of Branch geometry.
- o
GetSlackValue(double&)
- Method to get the slack value on Branch (when branch is created in "Slack" mode).
- o
IsLocalSlackApplied(CATBoolean&)
- Method to identify whether Local Slack is applied at least on a single portion of the Branch.
- o
ListLocalSlackValues(CATListValCATICkeParm_var&)
- Method to retrieve the Local Slack values on a branch
- o
ListProtectiveCovering(CATListValCATBaseUnknown_var**)
- Retrieves the list of Protective Coverings on the branch.
- o
ListSegments(CATListValCATBaseUnknown_var**)
- Lists the segments contained in the branch in an ordered list.
Methods
o GetBendRadius
| public virtual GetBendRadius( | | oBendRadius) |
-
Method to get the Bend Radius of the Branch.
- Parameters:
-
- oBendRadius
- (in MKS unit) bend radius of the branch.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while retreiving bend radius.
- Branch may be routed on an external curve.
o GetCreationMode
| public virtual GetCreationMode( | | ostrCreationMode) |
-
Method to get build method used to compute the branch.
"Slack" , "Length", "Bend" , "StraightBend" , "ConstrainedLength" or "CorneredPolyline".
- Parameters:
-
- ostrCreationMode
- creation mode of the branch.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while retreiving creation mode.
o GetHarnessBundle
| public virtual GetHarnessBundle( | | opHarnessBundle) |
-
Retrieves the harness bundle of the branch.
- Parameters:
-
- opHarnessBundle
- the harness bundle.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o GetLength
| public virtual GetLength( | | oLengthValue) |
-
Method to retreive the Branch length.
- Parameters:
-
- oLengthValue
- Length of the branch (in MKS unit).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while retreiving Branch Length.
o GetRouteGeometry
| public virtual GetRouteGeometry( | | opBodyRoute) |
-
Retrieves the topology of Branch geometry.
- Parameters:
-
- opBodyRoute
- the Body of Branch Route geometry.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o GetSlackValue
| public virtual GetSlackValue( | | oSlackValue) |
-
Method to get the slack value on Branch (when branch is created in "Slack" mode).
- Parameters:
-
- oSlackValue
- slack value on the branch (in percentage).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while retreiving slack value.
o IsLocalSlackApplied
| public virtual IsLocalSlackApplied( | | obIfLocalSlackApplied) |
-
Method to identify whether Local Slack is applied at least on a single portion of the Branch.
- Parameters:
-
- obIfLocalSlackApplied
- Output boolean to know if local slack applied or not.
- TRUE
- if local slack is applied on at least one portion between route points in branch.
- FALSE
- If there is no local slack applied on any portion of the branch.
- Returns:
- A HRESULT value.
Legal values:
- S_OK
- if local slack is applied on at least one portion between route points in branch.
- E_FAIL
- If there is no local slack applied on any portion of the branch.
o ListLocalSlackValues
| public virtual ListLocalSlackValues( | | ohListLocalSlackValues) |
-
Method to retrieve the Local Slack values on a branch
- Parameters:
-
- ohListLocalSlack
- returns the LocalSlack values at all route points of the branch
- Returns:
- A HRESULT value.
Legal values:
- S_OK
- if local slack values are retrieved.
- E_FAIL
- Failure to retrieve local slack values.
o ListProtectiveCovering
| public virtual ListProtectiveCovering( | | oListOfProtectiveCoverings) |
-
Retrieves the list of Protective Coverings on the branch.
- 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 ListSegments
| public virtual ListSegments( | | oListOfSegments) |
-
Lists the segments contained in the branch in an ordered list.
- Parameters:
-
- oListOfSegments
- The list of segments in the branch
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error occured while searching segments.
- E_FAIL
- Error.
This object is included in the file: CATIEhiBranch.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.