All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspCntrFlow

System.IUnknown
  |
  +---CATIPspCntrFlow
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIPspCntrFlow

Interface to mangage Plant-Ship Connector Flow property.
Role: To query and modify Plant-Ship Connector Flow property.


Method Index


o GetFlowCapability(CATPspCntrFlowCapability&)
Query the application Flow Capability property of this connector.
o GetFlowReality(CATPspCntrFlowReality&)
Query the application Flow Reality property of this connector.
o SetFlowCapability(CATPspCntrFlowCapability)
Set the application Flow Capability property of this connector.
o SetFlowReality(CATPspCntrFlowReality)
Set the application Flow Reality property of this connector.

Methods


o GetFlowCapability
public virtual HRESULT GetFlowCapability(CATPspCntrFlowCapability& oEFlowCapability) = 0
Query the application Flow Capability property of this connector.
Parameters:
oEFlowCapability
Flow Capability.
See also:
CATPspCntrFlowCapability
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetFlowReality
public virtual HRESULT GetFlowReality(CATPspCntrFlowReality& oEFlowReality) = 0
Query the application Flow Reality property of this connector.
Parameters:
oEFlowReality
Flow Reality.
See also:
CATPspCntrFlowReality
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetFlowCapability
public virtual HRESULT SetFlowCapability( const CATPspCntrFlowCapability iEFlowCapability) = 0
Set the application Flow Capability property of this connector.
Parameters:
iEFlowCapability
Flow Capability property to be set.
See also:
CATPspCntrFlowCapability
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetFlowReality
public virtual HRESULT SetFlowReality( const CATPspCntrFlowReality iEFlowReality) = 0
Set the application Flow Reality property of this connector.
Parameters:
iEFlowReality
Flow Reality property to be set.
See also:
CATPspCntrFlowReality
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspCntrFlow.h

Copyright © 2003, Dassault Systèmes. All rights reserved.