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_TYPE | A valid ignition message type. |
#include <src/backend/ign_publisher_system.h>
◆ IgnPublisherSystem() [1/2]
Constructs a publisher that forwards messages at a given fixed rate to the given ignition transport topic.
- Parameters
-
[in] | topic_name | The name of the ignition topic this system will be publishing to. |
[in] | publish_rate | The 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]
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_name | The name of the ignition topic this system will be publishing to. |
◆ ~IgnPublisherSystem()
◆ 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: