rad  3.0.0
Public Member Functions | List of all members
rad::cii::Publisher< TOPIC_TYPE > Class Template Reference

#include <publisher.hpp>

Public Member Functions

 Publisher (const elt::mal::Uri &uri, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
 ~Publisher ()
 
std::shared_ptr< TOPIC_TYPE > CreateTopic () const
 
void Publish (const TOPIC_TYPE &topic)
 
 Publisher (const Publisher &)=delete
 
Publisheroperator= (const Publisher &)=delete
 
 Publisher (const elt::mal::Uri &uri, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
 ~Publisher ()
 
std::shared_ptr< TOPIC_TYPE > CreateTopic () const
 
void Publish (const TOPIC_TYPE &topic)
 
 Publisher (const Publisher &)=delete
 
Publisheroperator= (const Publisher &)=delete
 
 Publisher (const elt::mal::Uri &uri, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
 ~Publisher ()
 
std::shared_ptr< TOPIC_TYPE > CreateTopic () const
 
void Publish (const TOPIC_TYPE &topic)
 
 Publisher (const Publisher &)=delete
 
Publisheroperator= (const Publisher &)=delete
 

Detailed Description

template<typename TOPIC_TYPE>
class rad::cii::Publisher< TOPIC_TYPE >

This class can be used to publish topics of a given type.

Template Parameters
TOPIC_TYPEType of the topic to be published.

TOPIC_TYPE = defined in the interface TOPIC_NAME = defined in the URI

Constructor & Destructor Documentation

◆ Publisher() [1/6]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::Publisher ( const elt::mal::Uri &  uri,
const std::optional< elt::mal::Mal::Properties >  mal_properties = {} 
)
inline

This constructor creates a publisher for a given topic type.

Parameters
uriTopic URI.
mal_propertiesQoS for the topic.

◆ ~Publisher() [1/3]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::~Publisher ( )
inline

Destructor.

◆ Publisher() [2/6]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::Publisher ( const Publisher< TOPIC_TYPE > &  )
delete

◆ Publisher() [3/6]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::Publisher ( const elt::mal::Uri &  uri,
const std::optional< elt::mal::Mal::Properties >  mal_properties = {} 
)
inline

This constructor creates a publisher for a given topic type.

Parameters
uriTopic URI.
mal_propertiesQoS for the topic.

◆ ~Publisher() [2/3]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::~Publisher ( )
inline

Destructor.

◆ Publisher() [4/6]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::Publisher ( const Publisher< TOPIC_TYPE > &  )
delete

◆ Publisher() [5/6]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::Publisher ( const elt::mal::Uri &  uri,
const std::optional< elt::mal::Mal::Properties >  mal_properties = {} 
)
inline

This constructor creates a publisher for a given topic type.

Parameters
uriTopic URI.
mal_propertiesQoS for the topic.

◆ ~Publisher() [3/3]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::~Publisher ( )
inline

Destructor.

◆ Publisher() [6/6]

template<typename TOPIC_TYPE >
rad::cii::Publisher< TOPIC_TYPE >::Publisher ( const Publisher< TOPIC_TYPE > &  )
delete

Member Function Documentation

◆ CreateTopic() [1/3]

template<typename TOPIC_TYPE >
std::shared_ptr<TOPIC_TYPE> rad::cii::Publisher< TOPIC_TYPE >::CreateTopic ( ) const
inline

This method creates a topic from a given topic type.

Template Parameters
TOPIC_TYPEType of the topic.

◆ CreateTopic() [2/3]

template<typename TOPIC_TYPE >
std::shared_ptr<TOPIC_TYPE> rad::cii::Publisher< TOPIC_TYPE >::CreateTopic ( ) const
inline

This method creates a topic from a given topic type.

Template Parameters
TOPIC_TYPEType of the topic.

◆ CreateTopic() [3/3]

template<typename TOPIC_TYPE >
std::shared_ptr<TOPIC_TYPE> rad::cii::Publisher< TOPIC_TYPE >::CreateTopic ( ) const
inline

This method creates a topic from a given topic type.

Template Parameters
TOPIC_TYPEType of the topic.

◆ operator=() [1/3]

template<typename TOPIC_TYPE >
Publisher& rad::cii::Publisher< TOPIC_TYPE >::operator= ( const Publisher< TOPIC_TYPE > &  )
delete

◆ operator=() [2/3]

template<typename TOPIC_TYPE >
Publisher& rad::cii::Publisher< TOPIC_TYPE >::operator= ( const Publisher< TOPIC_TYPE > &  )
delete

◆ operator=() [3/3]

template<typename TOPIC_TYPE >
Publisher& rad::cii::Publisher< TOPIC_TYPE >::operator= ( const Publisher< TOPIC_TYPE > &  )
delete

◆ Publish() [1/3]

template<typename TOPIC_TYPE >
void rad::cii::Publisher< TOPIC_TYPE >::Publish ( const TOPIC_TYPE &  topic)
inline

This method publishes a given topic.

Parameters
topicTopic to publish.

◆ Publish() [2/3]

template<typename TOPIC_TYPE >
void rad::cii::Publisher< TOPIC_TYPE >::Publish ( const TOPIC_TYPE &  topic)
inline

This method publishes a given topic.

Parameters
topicTopic to publish.

◆ Publish() [3/3]

template<typename TOPIC_TYPE >
void rad::cii::Publisher< TOPIC_TYPE >::Publish ( const TOPIC_TYPE &  topic)
inline

This method publishes a given topic.

Parameters
topicTopic to publish.

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