VISR  0.11.1
Versatile Interactive Scene Renderer
visr::CommunicationProtocolBase::Output Class Referenceabstract

#include <communication_protocol_base.hpp>

Inheritance diagram for visr::CommunicationProtocolBase::Output:
visr::pml::MessageQueueProtocol::OutputBase visr::pml::SharedDataProtocol::OutputBase visr::pml::MessageQueueProtocol::Output< MessageType > visr::pml::SharedDataProtocol::Output< MessageType >

Public Member Functions

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

Detailed Description

Abstract base class for communication protocol inputs. Communication protocols derived from CommunicationProtocolBase must provide a Input class derived from this base class and override its pure virtual methods.

Constructor & Destructor Documentation

◆ Output()

visr::CommunicationProtocolBase::Output::Output ( )

Default constructor. Because this class exports its symbol from a shared library, we need to provide an explicit constructor in order to avoid multiple auto-generated default constructors.

◆ ~Output()

virtual visr::CommunicationProtocolBase::Output::~Output ( )
virtual

Virtual destructor. Derived classes are instantiated and used polymorphically, therefore the destructor has to be virtual.

Member Function Documentation

◆ getProtocol() [1/2]

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

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

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

◆ getProtocol() [2/2]

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

Return a pointer to the connected communication protocol (const version), or nullptr if it is not connected.

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

◆ setProtocolInstance()

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

Set the protocol instance for this protocol input.

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


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