All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Interface CATIPspPlacePartOnRun
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspPlacePartOnRun
Interface to place physical parts on runs.
Role: Equipment and Systems applications are used to layout 3D AEC designs.
Fluid flow routes are defined using runs. Further detail is provided by adding
parts to runs. This interface is used to perform the placement of parts on runs.
Method Index
- o
FlipPlacedPart(IUnknown*)
- Flip an instance part which has been placed using the Part Placement Engine.
- o
GetReferencePartFromCatalog(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,IUnknown*,IUnknown*&)
- Fetches the catalog description that matches the input part number.
- o
PlacePartOnPartConnector(CATUnicodeString&,CATUnicodeString&,IUnknown*,IUnknown*,IUnknown*,CATUnicodeString&,IUnknown*&)
- Places a non-string part on a part connector.
- o
PlacePartOnRunNode(CATUnicodeString&,CATUnicodeString&,IUnknown*,IUnknown*,IUnknown*,CATUnicodeString&,IUnknown*&)
- Places a non-string part on a node of a run.
- o
PlacePartOnRunSegment(CATUnicodeString&,CATUnicodeString&,IUnknown*,IUnknown*,IUnknown*,CATUnicodeString&,CATMathPoint&,IUnknown*&)
- Places a part on a segment of a run.
Methods
o FlipPlacedPart
| public virtual FlipPlacedPart( | const | ipiPlacedInstancePart) |
-
Flip an instance part which has been placed using the Part Placement Engine.
Role: When a part is placed on a part connector or on a run there is
often more than one possible way to connect the part being placed. When there
is more than one such connection geometry the PP engine attempts to pick the
best one. This method allows the part to "flip" between the possible connection
geometries when more than one exists.
Part is placed non-spec.
- Parameters:
-
- ipiPlacedInstancePart
- The placed instance part to be flipped.
- Returns:
-
- S_OK part successfully flipped.
- E_FAIL otherwise.
o GetReferencePartFromCatalog
| public virtual GetReferencePartFromCatalog( | const | iuStandard, |
| const | iuSpecName, |
| const | iuPartType, |
| const | iuPartNumber, |
| const | ipiPhysicalParentProduct, |
| | opiReferencePart) |
-
Fetches the catalog description that matches the input part number.
Role: The part placement routines derive a part instance from an input reference.
This method can be used to provide that reference.
It gets the catalog description for a part with the given catalog part number
from the part catalog defined in the Equipment and Systems environment.
- Parameters:
-
- iuStandard
- Standard for application attribute values.
- iuSpecName
- Name of spec catalog. Null string uses full part catalog.
- iuPartType
- The part type under which to search for the part.
- iuPartNumber
- The catalog part number of the desired part.
- ipiPhysicalParentProduct
- In design model, the parent of the part that will be placed.
Having this object helps with efficiency. It may be set to NULL and
the method will still function correctly.
- opiReferencePart
- The reference part.
- Returns:
-
- S_OK catalog descruption successfully retrieved.
- E_FAIL otherwise.
o PlacePartOnPartConnector
| public virtual PlacePartOnPartConnector( | const | iuStandard, |
| const | iuFunctionType, |
| const | ipiReferencePart, |
| const | ipiPartConnector, |
| const | ipiLogicalLine, |
| const | iuPlacedPartID, |
| | opiInstancePart) |
-
Places a non-string part on a part connector.
Role: A part instance is derived from the given reference and placed on the given part connector.
The Part Placement engine will search for neighgoring parts on the run (or any connected runs)
and connect as needed.
Part is placed non-spec.
- Parameters:
-
- iuStandard
- The standard for application attribute values.
- iuFunctionType
- The type of function (e.g. block valve, branch).
- ipiReferencePart
- The reference part from which to derive the instance part.
- ipiPartConnector
- The run node on which the part will be placed.
- ipiLogicalLine
- The logical line (e.g. piping line) which contains the instance part.
If NULL the part is put in the logical line of the run.
- iuPlacedPartID
- The name of the placed part in the design model.
Null string uses the standard ID generated by the part placement engine.
- opiInstancePart
- The placed instance part.
- Returns:
-
- S_OK part successfully placed.
- E_FAIL otherwise.
o PlacePartOnRunNode
| public virtual PlacePartOnRunNode( | const | iuStandard, |
| const | iuFunctionType, |
| const | ipiReferencePart, |
| const | ipiRunNode, |
| const | ipiLogicalLine, |
| const | iuPlacedPartID, |
| | opiInstancePart) |
-
Places a non-string part on a node of a run.
Role: A part instance is derived from the given reference and placed on the given run node.
The Part Placement engine will search for neighgoring parts on the run (or any connected runs)
and connect as needed.
Part is placed non-spec.
- Parameters:
-
- iuStandard
- The standard for application attribute values.
- iuFunctionType
- The type of function (e.g. block valve, branch).
- ipiReferencePart
- The reference part from which to derive the instance part.
- ipiRunNode
- The run node on which the part will be placed.
- ipiLogicalLine
- The logical line (e.g. piping line) which contains the instance part.
If NULL the part is put in the logical line of the run.
- iuPlacedPartID
- The name of the placed part in the design model.
Null string uses the standard ID generated by the part placement engine.
- opiInstancePart
- The placed instance part.
- Returns:
-
- S_OK reference .
- E_FAIL otherwise.
o PlacePartOnRunSegment
| public virtual PlacePartOnRunSegment( | const | iuStandard, |
| const | iuFunctionType, |
| const | ipiReferencePart, |
| const | ipiRunSegment, |
| const | ipiLogicalLine, |
| const | iuPlacedPartID, |
| const | iPosition, |
| | opiInstancePart) |
-
Places a part on a segment of a run.
Role: A part instance is derived from the given reference and placed on the given run segment.
The Part Placement engine will search for neighgoring parts on the run (or any connected runs)
and adjust the placement location and connect as needed.
Part is placed non-spec.
- Parameters:
-
- iuStandard
- The standard for application attribute values.
- iuFunctionType
- The type of function (e.g. block valve, branch).
- ipiReferencePart
- The reference part from which to derive the instance part.
- ipiRunSegment
- The run segment on which the part will be placed.
- ipiLogicalLine
- The logical line (e.g. piping line) which contains the instance part.
If NULL the part is put in the logical line of the run.
- iuPlacedPartID
- The name of the placed part in the design model.
NULL uses the standard ID generated by the part placement engine.
- iPosition
- The position of the part on the segment.
The list has three values which represent the x, y and z values of a position in space.
Value is relative to the parent of the run and is in millimeters.
- opiInstancePart
- The placed instance part.
- Returns:
-
- S_OK part successfully placed.
- E_FAIL otherwise.
This object is included in the file: CATIPspPlacePartOnRun.h