delphyne
IgnPublisherSystem< IGN_TYPE, type > Class Template Reference

Detailed Description

template<typename IGN_TYPE, typename std::enable_if< std::is_base_of< ignition::transport::ProtoMsg, IGN_TYPE >::value, int >::type = 0>
class delphyne::IgnPublisherSystem< IGN_TYPE, type >

A system to publish ignition messages at its single abstract input port through an ignition transport topic.

Template Parameters
IGN_TYPEA valid ignition message type.

#include <src/backend/ign_publisher_system.h>

Inheritance diagram for IgnPublisherSystem< IGN_TYPE, type >:
[legend]

Public Member Functions

 IgnPublisherSystem (const std::string &topic_name, double publish_rate)
 Constructs a publisher that forwards messages at a given fixed rate to the given ignition transport topic. More...
 
 IgnPublisherSystem (const std::string &topic_name)
 Constructs a publisher that forwards messages at the fastest possible rate (i.e. More...
 
 ~IgnPublisherSystem () override
 Default destructor. More...
 
const std::string & get_topic_name ()
 Returns the topic name it publishes to. More...
 

Constructor & Destructor Documentation

◆ IgnPublisherSystem() [1/2]

IgnPublisherSystem ( const std::string &  topic_name,
double  publish_rate 
)
explicit

Constructs a publisher that forwards messages at a given fixed rate to the given ignition transport topic.

Parameters
[in]topic_nameThe name of the ignition topic this system will be publishing to.
[in]publish_rateThe publishing rate, in Hz.
Precondition
Given publish_rate is a positive number.
Warning
Failure to meet any of the preconditions will abort execution.

◆ IgnPublisherSystem() [2/2]

IgnPublisherSystem ( const std::string &  topic_name)
explicit

Constructs a publisher that forwards messages at the fastest possible rate (i.e.

on every simulation step) to the given ignition transport topic.

Parameters
[in]topic_nameThe name of the ignition topic this system will be publishing to.

◆ ~IgnPublisherSystem()

~IgnPublisherSystem ( )
override

Default destructor.

Member Function Documentation

◆ get_topic_name()

const std::string& get_topic_name ( )

Returns the topic name it publishes to.


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