CATFunctionalModelerUseItf Interface CATIFctMuxDemuxReference
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIFctMuxDemuxReference
Interface designating a Functional Mux/Demux Reference.
Role: This interface designates a Multiplexer/Demultiplexer Reference and provides means to manage its properties.
Method Index
- o
GetFlow(CATIFctFlowReference*&)
- Retrieves the structured flow associated to the Mux/Demux Reference.
- o
GetKind(CommunicationType&)
- Retrieves the kind of Mux/Demux Reference.
- o
GetPortFromSubFlow(CATIFctFlowInstance*,CATIFctPort*&)
- Retrieves the Functional Port corresponding to a subflow of the structured flow associated to the Mux/Demux Reference.
- o
ListPorts(CATListValCATIFctPort_var&,CATIFctPort*&)
- Lists the ports of the Mux/Demux Reference.
Enumerated Type Index
- o
CommunicationType
- Defines the kind of Mux/Demux Reference.
Methods
o GetFlow
| public virtual GetFlow( | | opStructuredFlowReference) |
-
Retrieves the structured flow associated to the Mux/Demux Reference.
Role: This method retrieves the structured Functional Flow Reference on which is built the Mux/Demux Reference structure.
- Parameters:
-
- opStructuredFlowReference
- [out, CATBaseUnknown#Release]
The Functional Flow Reference associated to the Mux/Demux Reference.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.
o GetKind
| public virtual GetKind( | | oType) |
-
Retrieves the kind of Mux/Demux Reference.
- Parameters:
-
- oType
- The kind of Mux/Demux Reference.
Output parameter.
- Returns:
-
S_OK if the method succeeds.
E_FAIL otherwise.
o GetPortFromSubFlow
| public virtual GetPortFromSubFlow( | | ipSubFlowInstance, |
| | opFunctionalPort) |
-
Retrieves the Functional Port corresponding to a subflow of the structured flow associated to the Mux/Demux Reference.
- Parameters:
-
- ipSubFlowInstance
- A Functional Flow Instance corresponding to a subflow of the structured flow.
Input parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
- opFunctionalPort
- [out, CATBaseUnknown#Release]
A Functional Port (of the Mux/Demux Reference).
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.
o ListPorts
| public virtual ListPorts( | | oLSubFlowPorts, |
| | opStructuredPort) |
-
Lists the ports of the Mux/Demux Reference.
Role: This method lists the 'subflow' Functional Ports associated to the direct subflows of the structured flow and
the 'structured' Functional Port associated to the structured flow.
- Parameters:
-
- oLSubFlowPorts
- A list of Functional Ports associated to the subflows of the structured flow.
Output parameter.
This parameter MUST be provided by caller as empty. This method returns an error otherwise.
This parameter is valuated if method succeeds.
- opStructuredPort
- [out, CATBaseUnknown#Release]
A Functional Port associated to the structured flow.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.
Enumerated Types
o CommunicationType
-
enum CommunicationType {
Multiplexer,
Demultiplexer
}
Defines the kind of Mux/Demux Reference.
- Parameters:
-
- Multiplexer
- The Reference is a Multiplexer.
- Demultiplexer
- The Reference is a Demultiplexer.
This object is included in the file: CATIFctMuxDemuxReference.h
If needed, your Imakefile.mk should include the module: CATFunctionalModelerUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.