CATHvacDesignUseItf Interface CATIHvaPartInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIHvaPartInstance
Interface to access Part Instance.
Role: Returns the PLM connected PLM Reference: Rigid Duct, Flexible Duct, Hvac Part, Insulation, Hvac Port.
This interface is implemented by PLM Occurrence
Method Index
- o
Connect(CATIHvaHvacPortRef*,CATBaseUnknown*,CATIHvaHvacPortRef*)
- Connects two objects together.
- o
Disconnect(CATBaseUnknown*)
- Disconnects two objects connected together.
- o
GetConnectedObject(CATBaseUnknown*&,CATIHvaHvacPortRef*&,CATIHvaHvacPortRef*)
- Gets the other connected object through the port.
- o
GetLogicalLine(CATIHvaLogicalLineInstance*&)
- Retrieves the Logical Line Instance if any.
- o
GetReference(CATIHvaPartReference*&)
- Gets the PLM reference of corresponding Hvac Part or Equipment Occurrence.
- o
GetRelatedObject(CATLISTP(CATBaseUnknown)*&)
- Gets the related object in term of insulation.
- o
GetSpool(CATIHvaSpoolInstance*&)
- Finds the Spool of current part if any.
- o
IsOKToConnect(CATBoolean&,CATIHvaHvacPortRef*,CATBaseUnknown*,CATIHvaHvacPortRef*)
- Checks if it is valid to connect this Object/Port to the other Object/Port.
Methods
o Connect
| public virtual Connect( | | ipIThisPort, |
| | ipIOtherConnectable, |
| | ipIOtherPort) |
-
Connects two objects together.
If the input other connectable is a part then this will be transformed to match correctly input port of this part to the input port of the other connectable part.
If the input other connectable is a route, then the route will get modified to get routed upto the port of this part.
- Parameters:
-
- ipIThisPort
- A port of this object [in, CATIHvaHvacPortRef].
- ipIOtherConnectable
- A connected object [in, CATBaseUnknown].
- ipIOtherPort
- A port of the other connected object where is done the connection [in, CATIHvaHvacPortRef].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- one or more arguments are invalid
- E_FAIL
- operation failed
o Disconnect
| public virtual Disconnect( | | ipOtherConnectable) |
-
Disconnects two objects connected together.
- Parameters:
-
- ipOtherConnectable
- A connected object [in, CATBaseUnknown].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- one or more arguments are invalid
- E_FAIL
- operation failed
o GetConnectedObject
| public virtual GetConnectedObject( | | opIOtherConnectable, |
| | opIOtherPort, |
| | ipIThisPort) |
-
Gets the other connected object through the port.
- Parameters:
-
- opIOtherConnectable
- A connected object [out, CATBaseUnknown#Release].
- opIOtherPort
- The port of the other connected object [out, CATIHvaHvacPortRef #Release].
- ipIThisPort
- A port of this object [in, CATIHvaHvacPortRef].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- ipIThisPort arguments are invalid
- E_FAIL
- operation failed
o GetLogicalLine
| public virtual GetLogicalLine( | | opiLogLine) |
-
Retrieves the Logical Line Instance if any.
Role: Retrieves the Logical Line Instance if any.
- Parameters:
-
- opiLogLine
- [out, CATIHvaLogicalLineInstance#Release] Interface pointer on Logical Line Instance. Can be NULL if no Logical Line has been found.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Operation is successful
- S_FALSE
- Operation is successful, but current Part is not in Logical Line.
- E_INVALIDARG
- The input argument opiLogLine is not NULL
- E_FAIL
- Otherwise
o GetReference
| public virtual GetReference( | | opIHvacPartRef) |
-
Gets the PLM reference of corresponding Hvac Part or Equipment Occurrence.
- Parameters:
-
- opIHvacPartRef
- return a pointer on reference [out, CATIHvaPartReference#Release].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetRelatedObject
| public virtual GetRelatedObject( | | opListObject) |
-
Gets the related object in term of insulation.
- Parameters:
-
- opListObject
- A List of related object to Hvac part [out, CATLISTP(CATBaseUnknown) #Release].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- ipIThisPort arguments are invalid
- E_FAIL
- operation failed
o GetSpool
| public virtual GetSpool( | | opISpoolInstance) |
-
Finds the Spool of current part if any.
- Parameters:
-
- opISpoolInstance[out,
- CATIHvaSpoolInstance#Release]. Interface pointer on spool occurence Can be NULL if current part is not in any spool .
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Operation is successful
- S_FALSE
- Operation is successful, but current part is not in any spool.
- E_INVALIDARG
- The input argument opISpoolInstance is not NULL
- E_FAIL
- Otherwise
o IsOKToConnect
| public virtual IsOKToConnect( | | obStatus, |
| | ipIThisPort, |
| | ipIOtherConnectable, |
| | ipIOtherPort) |
-
Checks if it is valid to connect this Object/Port to the other Object/Port.
- Parameters:
-
- obStatus
- The status if the connection is valid in term of compatibility [out, Boolean].
Legal values: True, the two elements can be connected.
- ipIThisPort
- A port of this object [in, CATIHvaHvacPortRef].
- ipIOtherConnectable
- The other object [in, CATBaseUnknown].
- ipIThisPort
- A port of the other object [in, CATIHvaHvacPortRef].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- one or more arguments are invalid
- E_FAIL
- operation failed
This object is included in the file: CATIHvaPartInstance.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.