CATHvacDesignUseItf Interface CATIHvaSpoolInstance

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIHvaSpoolInstance

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(CATIHvaSpoolInstance::CATHvaSpoolModeEnum&)
Gets mode of this spool.
o GetReference(CATIHvaSpoolReference*&)
Gets the PLM reference of corresponding Spool Occurrence.

Enumerated Type Index


o CATHvaSpoolModeEnum

Methods


o GetMembers
public virtual HRESULT GetMembers(CATLISTP(CATBaseUnknown)*& opListUnkSpoolMembers) = 0
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 HRESULT GetMode(CATIHvaSpoolInstance::CATHvaSpoolModeEnum& oHvaSpoolMode) = 0
Gets mode of this spool.
Parameters:
oHvaSpoolMode
[out, CATHvaSpoolModeEnum] Mode of spool.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetReference
public virtual HRESULT GetReference(CATIHvaSpoolReference*& opISpoolReference) = 0
Gets the PLM reference of corresponding Spool Occurrence.
Parameters:
opISpoolReference
Return a pointer on reference [out, CATIHvaSpoolReference#Release].
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

Enumerated Types


o CATHvaSpoolModeEnum 
enum CATHvaSpoolModeEnum {
  CatHvaEmptySpool,
  CatHvaPreliminaryDesign,
  CatHvaManufacturing,
  CatHvaMixOfPreliminaryAndManufacturing,
  CatHvaErrorWrongTypeOfElemInSpool
}
This object is included in the file: CATIHvaSpoolInstance.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.