OpenDaVINCI  4.15.3
odcore::io::conference::ContainerConference Class Referenceabstract

#include <ContainerConference.h>

Inheritance diagram for odcore::io::conference::ContainerConference:
Inheritance graph

Public Member Functions

virtual ~ContainerConference ()
 
virtual void setContainerListener (ContainerListener *cl)
 
ContainerListenergetContainerListener ()
 
virtual void send (odcore::data::Container &container) const =0
 
void setSenderStamp (const uint32_t &senderStamp)
 
uint32_t getSenderStamp () const
 

Protected Member Functions

 ContainerConference ()
 
void receive (odcore::data::Container &c)
 
bool hasContainerListener () const
 

Friends

class ContainerConferenceFactory
 

Detailed Description

This class provides an interface for a ContainerConference. A ContainerConference is either a UDPMultiCastContainerConference of a pure virtual conference as needed by simulation.

Constructor & Destructor Documentation

odcore::io::conference::ContainerConference::ContainerConference ( )
protected
odcore::io::conference::ContainerConference::~ContainerConference ( )
virtual

Member Function Documentation

ContainerListener * odcore::io::conference::ContainerConference::getContainerListener ( )

This method returns the registered ContainerListener.

Returns
registered container listener or NULL.
uint32_t odcore::io::conference::ContainerConference::getSenderStamp ( ) const

This method returns the user-defined attribute used for stamping any container that is sent.

Returns
user-defined attribute used for stamping containers.

Referenced by odcontext::base::ControlledContainerConferenceForSystemUnderTest::send().

bool odcore::io::conference::ContainerConference::hasContainerListener ( ) const
protected

This method returns true if a ContainerListener is registered.

Returns
true, iff a ContainerListener is registered.
void odcore::io::conference::ContainerConference::receive ( odcore::data::Container c)
protected

This method can be called from any subclass to distribute a newly received container.

Parameters
cContainer to be distributed.

References odcore::io::conference::ContainerListener::nextContainer().

Referenced by odcontext::base::ControlledContainerConferenceForSystemUnderTest::nextContainer(), and odcore::base::module::ManagedClientModuleContainerConference::receiveFromLocal().

virtual void odcore::io::conference::ContainerConference::send ( odcore::data::Container container) const
pure virtual
void odcore::io::conference::ContainerConference::setContainerListener ( ContainerListener cl)
virtual

This method sets or unsets a container listener.

Parameters
clContainerListener to be set. If set to NULL, observing is suspended.

Implements odcore::io::conference::ContainerObserver.

void odcore::io::conference::ContainerConference::setSenderStamp ( const uint32_t &  senderStamp)

This method sets a user-defined attribute to be used for stamping any container that is sent.

Parameters
senderStampUser-defined attribute used for stamping containers.

Friends And Related Function Documentation

friend class ContainerConferenceFactory
friend