ElecHarnessItf Interface CATIEhiProtectiveCovering
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiProtectiveCovering
Interface to manage a Protection .
Role:A Protection is a protective covering on a group of segments.
Method Index
- o
GetEndPointsGeometry(CATBody**,CATBody**)
- Retrieves the topology of Protection Ends geometry.
- o
GetType(CATUnicodeString&)
- Retrieves the protection type.
- o
ListCoveredSegments(CATListValCATBaseUnknown_var**)
- Lists the segments covered by this protection.
Methods
o GetEndPointsGeometry
| public virtual GetEndPointsGeometry( | | opEndPoint1, |
| | opEndPoint2) |
-
Retrieves the topology of Protection Ends geometry.
- Parameters:
-
- opEndPoint1
- the Body of Protection End1 geometry.
- opEndPoint2
- the Body of Protection End2 geometry.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o GetType
| public virtual GetType( | | ostrProtectionType) |
-
Retrieves the protection type.
- Parameters:
-
- oProtectionType
- Output: Type of the protection:
ElecAdaptiveProtection
ElecFixedProtection
ElecTapeProtection
ElecCorrugatedProtection
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o ListCoveredSegments
| public virtual ListCoveredSegments( | | opIListSegment) |
-
Lists the segments covered by this protection.
- Parameters:
-
- opIListSegment
- The list of segments covered by the protection
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error occured while searching segments.
- E_FAIL
- Error.
This object is included in the file: CATIEhiProtectiveCovering.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.