CATPipeTubeDesignUseItf Interface CATIPipSpoolInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPipSpoolInstance
This interface is implemented by Spool Occurrence.
It gives information about Spool Modes.
Role: Spool Identification and Mode Information.
Method Index
- o
GetMembers(CATLISTP(CATBaseUnknown)*&)
- Gets the list of the spool members in Preliminary or Manufacturing mode.
- o
GetMode(CATIPipSpoolInstance::CATPipSpoolModeEnum&)
- Gets mode of this spool.
- o
GetReference(CATIPipSpoolReference*&)
- Gets the PLM reference of corresponding Spool Occurrence.
Enumerated Type Index
- o
CATPipSpoolModeEnum
-
Methods
o GetMembers
| public virtual GetMembers( | | opListUnkSpoolMembers) |
-
Gets the list of the spool members in Preliminary or Manufacturing mode.
- Parameters:
-
- opListUnkSpoolMembers[out,
- CATLISTP(CATBaseUnknown)#Release]. List of the members of the spool.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- it is not a Preliminary or Manufacturing mode spool Or opListUnkSpoolMembers is not NULL
- E_FAIL
- operation failed
o GetMode
| public virtual GetMode( | | oPipSpoolMode) |
-
Gets mode of this spool.
- Parameters:
-
- oPipSpoolMode
- [out, CATPipSpoolModeEnum] Mode of spool.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetReference
| public virtual GetReference( | | opISpoolReference) |
-
Gets the PLM reference of corresponding Spool Occurrence.
- Parameters:
-
- opISpoolReference
- Return a pointer on reference [out, CATIPipSpoolReference#Release].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
Enumerated Types
o CATPipSpoolModeEnum
-
enum CATPipSpoolModeEnum {
CatPipEmptySpool,
CatPipPreliminaryDesign,
CatPipManufacturing,
CatPipMixOfPreliminaryAndManufacturing,
CatPipErrorWrongTypeOfElemInSpool
}
This object is included in the file: CATIPipSpoolInstance.h
If needed, your Imakefile.mk should include the module: CATPipeTubeDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.