CATLogicalModelerUseItf Interface CATILogMuxDemuxReference
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATILogMuxDemuxReference
Interface designating a Logical Mux/Demux Reference.
Role: This interface designates a Multiplexer/Demultiplexer Reference and provides means to manage its properties.
Method Index
- o
GetKind(CommunicationType&)
- Retrieves the kind of Mux/Demux Reference.
- o
GetPortFromSubType(CATILogTypeInstance*,CATILogPort*&)
- Retrieves the Logical Port corresponding to a subtype of the structured type associated to the Mux/Demux Reference.
- o
GetType(CATILogTypeReference*&)
- Retrieves the structured type associated to the Mux/Demux Reference.
- o
ListPorts(CATListValCATILogPort_var&,CATILogPort*&)
- Lists the ports of the Mux/Demux Reference.
Enumerated Type Index
- o
CommunicationType
- Defines the kind of Mux/Demux Reference.
Methods
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 GetPortFromSubType
| public virtual GetPortFromSubType( | | ipSubTypeInstance, |
| | opLogicalPort) |
-
Retrieves the Logical Port corresponding to a subtype of the structured type associated to the Mux/Demux Reference.
- Parameters:
-
- ipSubTypeInstance
- A Logical Type Instance corresponding to a subtype of the structured type.
Input parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
- opLogicalPort
- [out, CATBaseUnknown#Release]
A Logical 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 GetType
| public virtual GetType( | | opStructuredTypeReference) |
-
Retrieves the structured type associated to the Mux/Demux Reference.
Role: This method retrieves the structured Logical Type Reference on which is built the Mux/Demux Reference structure.
- Parameters:
-
- opStructuredTypeReference
- [out, CATBaseUnknown#Release]
The Logical Type 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 ListPorts
| public virtual ListPorts( | | oLSubTypePorts, |
| | opStructuredPort) |
-
Lists the ports of the Mux/Demux Reference.
Role: This method lists the 'subtype' Logical Ports associated to the direct subtypes of the structured type and
the 'structured' Logical Port associated to the structured type.
- Parameters:
-
- oLSubTypePorts
- A list of Logical Ports associated to the subtypes of the structured type.
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 Logical Port associated to the structured type.
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: CATILogMuxDemuxReference.h
If needed, your Imakefile.mk should include the module: CATLogicalModelerUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.