CATHvacDesignUseItf Interface CATIHvaRigidDuctReference
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIHvaRigidDuctReference
Method Index
- o
GetAllPoints(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Gets the list of all point features of the duct
- o
GetArcLengthofNode(CATListOfDouble&)
- Gets the Arc Length of Node.
- o
GetBendAngleofNode(CATListOfDouble&)
- Gets the Bend angle of Node.
- o
GetBendRadiusofNode(CATListOfDouble&)
- Gets the Bend radius of Node.
- o
GetCoordinateofNode(CATLISTP(CATMathPoint)&,CATBaseUnknown*)
- Gets the coordinate of Node.
- o
GetEnds(CATIHvaHvacPortRef*&,CATIHvaHvacPortRef*&)
- Gets the two end of Duct.
- o
GetGuideCurve(CATIMmiMechanicalFeature*&)
- Gets the guide curve of duct.
- o
GetInteriorNode(int,CATIHvaHvacPortRef*&)
- Gets the interior node of route.
- o
GetNumberOfNode(int&)
- Gets the number of nodes in Duct.
- o
GetRotationPlaneofNode(CATListOfDouble&)
- Gets the Rotation Plane angle of Node.
- o
GetStraightLengthofSegment(CATListOfDouble&)
- Gets the Straight Length of segment.
- o
GetSweep(CATIMmiMechanicalFeature*&)
- Gets the sweep of duct.
- o
ListBranchPorts(CATLISTP(CATIHvaHvacPortRef)&,CATListOfDouble&)
- Gets the list of all the branch Ports.
Methods
o GetAllPoints
| public virtual GetAllPoints( | | ohListofMMiPointFeatures) |
-
Gets the list of all point features of the duct
- Parameters:
-
- ohListofMMiPointFeatures
- List of points of the duct
The size of this list is equal to oNumberOfNode from GetNumberOfNode.
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - ohListofMMiPointFeatures is not empty
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetArcLengthofNode
| public virtual GetArcLengthofNode( | | opListofArcLengthofNode) |
-
Gets the Arc Length of Node.
- Parameters:
-
- opListofArcLengthofNode
- This method returns a list of Double that is the Arc length of Node.
The size of this list is equal to oNumberOfNode from GetNumberOfNode.
[out, CATListOfDouble]
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - output list is not empty
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetBendAngleofNode
| public virtual GetBendAngleofNode( | | opListofBendAngleofNode) |
-
Gets the Bend angle of Node.
- Parameters:
-
- opListofBendRadiusofNode
- This method returns a list of Double that is the bend angle on Node.
The size of this list is equal to oNumberOfNode from GetNumberOfNode.
[out, CATListOfDouble]
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - output list is not empty
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetBendRadiusofNode
| public virtual GetBendRadiusofNode( | | opListofBendRadiusofNode) |
-
Gets the Bend radius of Node.
- Parameters:
-
- opListofBendRadiusofNode
- This method returns a list of Double that is the bend radius on Node.
The size of this list is equal to oNumberOfNode from GetNumberOfNode.
[out, CATListOfDouble]
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - output list is not empty
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetCoordinateofNode
| public virtual GetCoordinateofNode( | | oListPofCoordinateNode, |
| | ipIUnkOccToFindRoot | = NULL ) |
-
Gets the coordinate of Node.
- Parameters:
-
- oListPofCoordinateNode
- (need to release it) This method returns a list of CATMathPoint pointers that is the coordinate of Node in context
of Root product of the session in milimeters (mm). Root product will be found using the input ipIUnkOccToFindRoot.
The size of this list is equal to oNumberOfNode from GetNumberOfNode.
[out, CATLISTP(CATMathPoint)].
- ipIUnkOccToFindRoot
- Occurrence used to find the Root Product in which context the coordinates of the nodes will be given out. If this input is NULL, then co-ordinates of the node will be in the context of the Reference of Duct.
[in, CATBaseUnknown].
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - output list is not empty
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetEnds
| public virtual GetEnds( | | opIEndDuctOne, |
| | opIEndDuctTwo) |
-
Gets the two end of Duct.
- Parameters:
-
- opIEndDuctOne
- Duct end one [out, CATIHvaHvacPortRef#Release].
- opIEndDuctTwo
- Duct end two [out, CATIHvaHvacPortRef#Release].
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - any one or both of the output pointers is not NULL
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetGuideCurve
| public virtual GetGuideCurve( | | opIMMiCurveFeature) |
-
Gets the guide curve of duct.
- Parameters:
-
- opIMMiCurveFeature
- Guide curve of the duct [out, CATIMmiMechanicalFeature#Release].
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - opIMMiCurveFeature is not NULL
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetInteriorNode
| public virtual GetInteriorNode( | | iRouteIndex, |
| | opIPortRefInteriorNode) |
-
Gets the interior node of route.
- Parameters:
-
- iRouteIndex
- route index from which the interior node is returned.
- opIPortRefInteriorNode
- Duct interior node [out, CATIHvaHvacPortRef#Release].
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input Route Index is extremity index of route or Route index not valid
- opIPortRefInteriorNode is not NULL
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetNumberOfNode
| public virtual GetNumberOfNode( | | oNumberOfNode) |
-
Gets the number of nodes in Duct.
- Parameters:
-
- oNumberOfNode
- Give the number of nodes that defines the Duct curve.
Include: Directional point, passing point (which is or not an external reference),
point which is External reference that come from Support or Hvac Part with Hole Port.
The point of 1 point Part Port or 2 points Part port is also included.
[out, Integer].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetRotationPlaneofNode
| public virtual GetRotationPlaneofNode( | | opListofRotationPlaneofNode) |
-
Gets the Rotation Plane angle of Node.
- Parameters:
-
- opListofRotationPlaneofNode
- This method returns a list of Double that is the Rotation plane angle of Node.
The size of this list is equal to oNumberOfNode from GetNumberOfNode.
[out, CATListOfDouble]
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - output list is not empty
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetStraightLengthofSegment
| public virtual GetStraightLengthofSegment( | | opListofStraightLengthofsegment) |
-
Gets the Straight Length of segment.
- Parameters:
-
- opListofStraightLengthofsegment
- (need to release it) This method returns a list of Double that is the Straight Length of segment.
The size of this list is equal to (oNumberOfNode-1) from GetNumberOfNode.
index =1 is the length between Node 1 to Node 2, etc...
[out, CATListOfDouble]
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - output list is not empty
- S_OK
- operation is successful, even if there is Zero node to define this Duct
- E_FAIL
- operation failed
o GetSweep
| public virtual GetSweep( | | opIMMiSweepFeature) |
-
Gets the sweep of duct.
- Parameters:
-
- opIMMiSweepFeature
- Sweep of the duct [out, CATIMmiMechanicalFeature#Release].
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - opIMMiSweepFeature is not NULL
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListBranchPorts
| public virtual ListBranchPorts( | | opListPorts, |
| | opListCurvilinearLength) |
-
Gets the list of all the branch Ports.
- Parameters:
-
- opListPorts
- List of all ports of this object [out, CATLISTP(CATIHvaHvacPortRef)].
- opListCurvilinearLength
- List of curvilinear position of branch port on Duct curve [out, CATListOfDouble].
This list has the same size of opListPorts. There is a mapping where same index is same port.
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Input is invalid - any one or both of the output list is not empty
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIHvaRigidDuctReference.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.