VISR  0.11.8
Versatile Interactive Scene Renderer
visr::CommunicationProtocolBase::Input Class Referenceabstract

#include <communication_protocol_base.hpp>

Inheritance diagram for visr::CommunicationProtocolBase::Input:
visr::pml::MessageQueueProtocol::InputBase visr::pml::SharedDataProtocol::InputBase visr::pml::MessageQueueProtocol::Input< MessageType > visr::pml::SharedDataProtocol::Input< MessageType >

Public Member Functions

 Input ()
 
virtual ~Input ()
 
virtual void setProtocolInstance (CommunicationProtocolBase *protocol)=0
 
virtual CommunicationProtocolBasegetProtocol ()=0
 
virtual CommunicationProtocolBase const * getProtocol () const =0
 

Detailed Description

Abstract interface for an input to a protocol. Communication protocols derived from CommunicationProtocolBase must define classes derived from this base interface, implementing its pure virtual methods.

Constructor & Destructor Documentation

◆ Input()

visr::CommunicationProtocolBase::Input::Input ( )

Default constructor. Because the class is exported, it has to be defined and implemented (using =default) to prevent multiple symbols in MSVC.

◆ ~Input()

virtual visr::CommunicationProtocolBase::Input::~Input ( )
virtual

Virtual destructor. This class is intended to be instantiated and used polymorphically.

Member Function Documentation

◆ getProtocol() [1/2]

virtual CommunicationProtocolBase* visr::CommunicationProtocolBase::Input::getProtocol ( )
pure virtual

Return a pointer to the connected protocol, or nullptr if it is not connected.

Implemented in visr::pml::MessageQueueProtocol::InputBase, and visr::pml::SharedDataProtocol::InputBase.

◆ getProtocol() [2/2]

virtual CommunicationProtocolBase const* visr::CommunicationProtocolBase::Input::getProtocol ( ) const
pure virtual

Return a pointer to the connected protocol, const version. If the input is not connected, return nullptr.

Implemented in visr::pml::MessageQueueProtocol::InputBase, and visr::pml::SharedDataProtocol::InputBase.

◆ setProtocolInstance()

virtual void visr::CommunicationProtocolBase::Input::setProtocolInstance ( CommunicationProtocolBase protocol)
pure virtual

Connect the input to protocol instance.

Implemented in visr::pml::MessageQueueProtocol::InputBase, and visr::pml::SharedDataProtocol::InputBase.


The documentation for this class was generated from the following file: