All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Interface CATIPspSpatial
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspSpatial
Interface to access Plant Ship spatial object information.
Role: To access Plant Ship object information.
Method Index
- o
ListConnectedPhysicals(CATIArrNode_var&,CATIUnknownList*&,CATIUnknownList*&)
- Return all physical objects associated to this spatial object.
- o
ListPhysicals(CATIUnknownList*&)
- Return all physical objects associated to this spatial object.
Methods
o ListConnectedPhysicals
| public virtual ListConnectedPhysicals( | const | ispNode, |
| | oListOfPhysicals, |
| | oListOfConnectors) |
-
Return all physical objects associated to this spatial object.
- Parameters:
-
- ispNode
- The extremity node of a run.
- oListOfPhysicals
- [out, IUnknown#Release] List of physical objects that is connected to the given node.
- oListOfConnectors
- [out, IUnknown#Release] List of connectors connected to the extremity node.
One-to-one correspondence with oListOfPhysicals.
- Returns:
- An HRESULT value.
Legal values:
- E_INVALIDARG
- Invalid argument
- S_OK
- Found a connected physical object
- E_FAIL
- operation failed
o ListPhysicals
| public virtual ListPhysicals( | | oListOfPhysicals) |
-
Return all physical objects associated to this spatial object.
- Parameters:
-
- oListOfPhysicals
- [out, IUnknown#Release] List of physical objects.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspSpatial.h