#include <shared_data_protocol.hpp>
◆ SharedDataProtocol()
◆ ~SharedDataProtocol()
visr::pml::SharedDataProtocol::~SharedDataProtocol |
( |
| ) |
|
|
overridevirtualdefault |
◆ connectInput()
Connect a protocol input to this protocol. Derived protocol types must override this pure virtual interface.
- Parameters
-
port | An parameter input with compatible protocol and parameter types. |
- Exceptions
-
std::exception | If the protocol or parameter types do not match. |
std::exception | If the connection would violate the "arity" of the protocol, i.e., attempting multiple inputs in case of a 1:1 or 1:N protocol. |
Implements visr::CommunicationProtocolBase.
◆ connectOutput()
Connect a protocol output to this protocol. Derived protocol types must override this pure virtual interface.
- Parameters
-
port | An parameter output with compatible protocol and parameter types. |
- Exceptions
-
std::exception | If the protocol or parameter types do not match. |
std::exception | If the connection would violate the "arity" of the protocol, i.e., attempting multiple outputs in case of a 1:1 or N:1 protocol. |
Implements visr::CommunicationProtocolBase.
◆ data() [1/2]
◆ data() [2/2]
ParameterBase const& visr::pml::SharedDataProtocol::data |
( |
| ) |
const |
|
inline |
◆ disconnectInput()
Disconnect a protocol input from this protocol.
- Returns
- true if the disconnect was successful, i.e., if the protocol port was actually connected, false otherwise.
Implements visr::CommunicationProtocolBase.
◆ disconnectOutput()
Disconnect a protocol output from this protocol.
- Returns
- true if the disconnect was successful, i.e., if the protocol port was actually connected, false otherwise.
Implements visr::CommunicationProtocolBase.
◆ parameterType()
ParameterType visr::pml::SharedDataProtocol::parameterType |
( |
| ) |
const |
|
overridevirtual |
Return the configured parameter type of this protocol instance. Derived protocols are requirted to override this method.
Implements visr::CommunicationProtocolBase.
◆ protocolType()
Return the protocol type (a numerical id) of the concrete derived protocol object. Derived protocol types are required to override this method.
Implements visr::CommunicationProtocolBase.
◆ staticName()
static constexpr const char* visr::pml::SharedDataProtocol::staticName |
( |
| ) |
|
|
inlinestatic |
◆ staticType()
The documentation for this class was generated from the following files: