CATPipeTubeDesignUseItf Interface CATIPipPipingPortRef
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPipPipingPortRef
This interface is implemented by PLM Piping Port Reference , Start and End Extremities of Pipe , Interior node and flexible branch ports.
Role: Retrieve the reference piping 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
PostconditionPiping Part reference or Pipe/Tube Reference because are the alone types retrievable because of branch Port.
- o
GetType(CATPipGeomPortTypeEnum&)
- Gets the geometric port type.
Enumerated Type Index
- o
CATPipGeomPortTypeEnum
-
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
PostconditionPiping Part reference or Pipe/Tube 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 CATPipGeomPortTypeEnum
-
enum CATPipGeomPortTypeEnum {
CatPipUndefinedPort,
CatPipPartPort,
CatPip2PartPort,
CatPipHolePort,
CatPip2HolePort,
CatPipRouteStartExtremity,
CatPipRouteEndExtremity,
CatPipRouteBranchPort,
CatPipGeometricalMain,
CatPipRouteInteriorNode
}
This object is included in the file: CATIPipPipingPortRef.h
If needed, your Imakefile.mk should include the module: CATPipeTubeDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.