CATHvacDesignUseItf Interface CATIHvaHvacPortRef
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIHvaHvacPortRef
This interface is implemented by PLM Hvac Port Reference and , Start and End Extremities of Duct , Interior node and flexible branch ports.
Role: Retrieve the reference Hvac information on Port.
Method Index
- o
GetConstraintElements(CATMathPoint*&,CATMathVector*&,CATMathVector*&)
- Retrieves the constraint Elements of the connection point.
- o
GetOwner(CATBaseUnknown*&)
- Retrieves the Owner of the port as a pointer to the CATBaseUnknown
PostconditionHvac Part reference or Duct Reference because are the alone types retrievable because of branch Port.
- o
GetType(CATHvaGeomPortTypeEnum&)
- Gets the geometric port type.
Enumerated Type Index
- o
CATHvaGeomPortTypeEnum
-
Methods
o GetConstraintElements
| public virtual GetConstraintElements( | | opIPoint, |
| | opITangency, |
| | opIOrientation) |
-
Retrieves the constraint Elements of the connection point.
All the mathematical data are in context of the Part Refernce aggregating this Port.
- Parameters:
-
- opIPoint
- Element defining connection point.
[out, CATMathPoint#Delete]
- opITangency
- Element defining coincidence or tangency (can be NULL)
[out, CATMathVector#Delete]
- opIOrientation
- Element defining orientation (can be NULL)
[out, CATMathVector#Delete]
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_INVALIDARG
- Input Pointers are NOT NULL. They need to be NULL, because memory will be allocated into them inside this method.
- E_FAIL
- operation failed
o GetOwner
| public virtual GetOwner( | | opICBUOwner) |
-
Retrieves the Owner of the port as a pointer to the CATBaseUnknown
PostconditionHvac Part reference or Duct Reference because are the alone types retrievable because of branch Port.
- Parameters:
-
- opICBUOwner
- The pointer to the object reference which owns the port is returned.
[out, CATBaseUnknown#Release]
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetType
| public virtual GetType( | | oePortType) |
-
Gets the geometric port type.
- Parameters:
-
- oePortType
- The geometric port type value that can be 4 values:
one point Part port, Two points part port, one point Hole port,
two points Hole port.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
Enumerated Types
o CATHvaGeomPortTypeEnum
-
enum CATHvaGeomPortTypeEnum {
CatHvaUndefinedPort,
CatHvaPartPort,
CatHva2PartPort,
CatHvaHolePort,
CatHva2HolePort,
CatHvaRouteStartExtremity,
CatHvaRouteEndExtremity,
CatHvaRouteBranchPort,
CatHvaGeometricalMain,
CatHvaRouteInteriorNode
}
This object is included in the file: CATIHvaHvacPortRef.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.