VISR  0.12.0
Versatile Interactive Scene Renderer
visr::pml::MessageQueueProtocol::InputBase Class Reference

#include <message_queue_protocol.hpp>

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

Public Member Functions

 InputBase ()
 
virtual ~InputBase ()
 
void setProtocolInstance (CommunicationProtocolBase *protocol) override
 
MessageQueueProtocolgetProtocol () override
 
MessageQueueProtocol const * getProtocol () const override
 
bool empty () const
 
std::size_t size () const
 
ParameterBase const & front () const
 
void pop ()
 
void clear ()
 
void setProtocolInstance (MessageQueueProtocol *protocol)
 
- Public Member Functions inherited from visr::CommunicationProtocolBase::Input
 Input ()
 
virtual ~Input ()
 

Constructor & Destructor Documentation

◆ InputBase()

visr::pml::MessageQueueProtocol::InputBase::InputBase ( )
inline

Default constructor.

◆ ~InputBase()

virtual visr::pml::MessageQueueProtocol::InputBase::~InputBase ( )
virtual

Member Function Documentation

◆ clear()

void visr::pml::MessageQueueProtocol::InputBase::clear ( )
inline

◆ empty()

bool visr::pml::MessageQueueProtocol::InputBase::empty ( ) const
inline

◆ front()

ParameterBase const& visr::pml::MessageQueueProtocol::InputBase::front ( ) const
inline

◆ getProtocol() [1/2]

MessageQueueProtocol* visr::pml::MessageQueueProtocol::InputBase::getProtocol ( )
inlineoverridevirtual

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

Implements visr::CommunicationProtocolBase::Input.

◆ getProtocol() [2/2]

MessageQueueProtocol const* visr::pml::MessageQueueProtocol::InputBase::getProtocol ( ) const
inlineoverridevirtual

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

Implements visr::CommunicationProtocolBase::Input.

◆ pop()

void visr::pml::MessageQueueProtocol::InputBase::pop ( )
inline

◆ setProtocolInstance() [1/2]

void visr::pml::MessageQueueProtocol::InputBase::setProtocolInstance ( CommunicationProtocolBase protocol)
overridevirtual

Connect the input to protocol instance.

Implements visr::CommunicationProtocolBase::Input.

◆ setProtocolInstance() [2/2]

void visr::pml::MessageQueueProtocol::InputBase::setProtocolInstance ( MessageQueueProtocol protocol)
inline

◆ size()

std::size_t visr::pml::MessageQueueProtocol::InputBase::size ( ) const
inline

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