All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Interface CATIPspPhysical
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspPhysical
Interface to access Plant Ship physical object information.
Role: To access Plant Ship object information.
Method Index
- o
DisassociateFunction()
- Disassociate the existing function.
- o
GetFunctional(IUnknown*&)
- Return the functional object.
- o
GetSpatial(IUnknown*&)
- Get the spatial object.
- o
HasFunction(CATBoolean&)
- Query if the physical object is created with a function.
- o
ReplaceFunction(IUnknown*)
- Replace existing function.
Methods
o DisassociateFunction
| public virtual DisassociateFunction( | ) |
-
Disassociate the existing function.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetFunctional
| public virtual GetFunctional( | | oFunctional) |
-
Return the functional object.
- Parameters:
-
- oFunctional
- [out, IUnknown#Release] Functional object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FALSE
- operation failed
o GetSpatial
| public virtual GetSpatial( | | oSpatial) |
-
Get the spatial object.
- Parameters:
-
- oSpatial
- [out, IUnknown#Release] Spatial object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o HasFunction
| public virtual HasFunction( | | oStatus) |
-
Query if the physical object is created with a function.
- Parameters:
-
- oStatus
- True or False.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ReplaceFunction
| public virtual ReplaceFunction( | const | ipNewFunction) |
-
Replace existing function.
- Parameters:
-
- ipFunction
- New function to replace
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspPhysical.h