CATHvacDesignUseItf Interface CATIHvaEquipmentInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIHvaEquipmentInstance
Interface to access Equipment Instance.
Role: Access Equipment Instance.
This interface is implemented by PLM Occurrence of Equipment.
Method Index
- o
GetConnectedObject(CATIHvaHvacPortRef*&,CATBaseUnknown*&,CATIHvaHvacPortRef*)
- Retrieves the other connectable object and Port at this Equipment Port.
- o
GetReference(CATIHvaEquipmentReference*&)
- Retrieves the Equipment Reference.
Methods
o GetConnectedObject
| public virtual GetConnectedObject( | | opiOtherPort, |
| | opiOtherConnectable, |
| | ipiThisPort) |
-
Retrieves the other connectable object and Port at this Equipment Port.
Role: Retrieves the other connectable object and Port at this Equipment Port.
- Parameters:
-
- opiOtherPort
- [out, CATIHvaHvacPortRef#Release] Port of the other connected object.
- opiOtherConnectable
- [out, CATBaseUnknown#Release] The connected object (adhere to
or
).
- ipiThisPort
- Port of this object which is connected to opiOtherPort.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Operation is successful
- E_INVALIDARG
- At least one input argument is invalid.
-
- E_FAIL
- Otherwise
o GetReference
| public virtual GetReference( | | opiEquipment) |
-
Retrieves the Equipment Reference.
Role: Retrieves the Equipment Reference.
- Parameters:
-
- opiEquipment
- [out, CATIHvaEquipmentReference#Release] Interface pointer on Equipment Reference.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Operation is successful
- E_INVALIDARG
- The input argument opiEquipment is not NULL
- E_FAIL
- Otherwise
This object is included in the file: CATIHvaEquipmentInstance.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.