State Machine
Tools for creating and running general purpose state machines.
state_machine_ros::ReportInterfaceRos Class Reference

#include <ReportInterfaceRos.hpp>

Inheritance diagram for state_machine_ros::ReportInterfaceRos:
Inheritance graph

Public Member Functions

 ReportInterfaceRos (ros::NodeHandle &nodeHandle, const std::string &entryTopic, const uint32_t entryQueueSize, const bool entryLatch)
 
 ~ReportInterfaceRos () override=default
 
void addEntry (const report::Entry &entry) override
 
- Public Member Functions inherited from state_machine::ReportInterface
 ReportInterface ()=default
 
virtual ~ReportInterface ()=default
 
report::Entry createEntry (const State *authorState, const bool isExtendedEntry=true)
 
report::Entry createEntryStart (const State *authorState, const bool isExtendedEntry=true)
 
report::Entry createEntryOk (const State *authorState, const bool isExtendedEntry=true)
 
report::Entry createEntryNotOk (const State *authorState, const bool isExtendedEntry=true)
 
report::Entry createEntrySuccess (const State *authorState, const std::string &message="", const bool isExtendedEntry=true)
 
report::Entry createEntryPreempt (const State *authorState, const std::string &message="", const bool isExtendedEntry=true)
 
report::Entry createEntryWarning (const State *authorState, const std::string &message="", const std::string &status="", const bool isExtendedEntry=true)
 
report::Entry createEntryFailure (const State *authorState, const std::string &message="", const bool isExtendedEntry=true)
 
void addEntryStart (const State *authorState, const bool isExtendedEntry=true)
 
void addEntryOk (const State *authorState, const bool isExtendedEntry=true)
 
void addEntryNotOk (const State *authorState, const bool isExtendedEntry=true)
 
void addEntrySuccess (const State *authorState, const std::string &message="", const bool isExtendedEntry=true)
 
void addEntryPreempt (const State *authorState, const std::string &message="", const bool isExtendedEntry=true)
 
void addEntryWarning (const State *authorState, const std::string &message="", const std::string &status="", const bool isExtendedEntry=true)
 
void addEntryFailure (const State *authorState, const std::string &message="", const bool isExtendedEntry=true)
 

Protected Attributes

ros::NodeHandle & nodeHandle_
 
ros::Publisher entryPublisher_
 

Detailed Description

ROS interface to write a report.

Constructor & Destructor Documentation

◆ ReportInterfaceRos()

state_machine_ros::ReportInterfaceRos::ReportInterfaceRos ( ros::NodeHandle &  nodeHandle,
const std::string &  entryTopic,
const uint32_t  entryQueueSize,
const bool  entryLatch 
)

Constructor.

Parameters
nodeHandleROS node handle.
entryTopicTopic to publish entries to.
entryQueueSizeQueue size for publishing entries.
entryLatchLatch published entries.

◆ ~ReportInterfaceRos()

state_machine_ros::ReportInterfaceRos::~ReportInterfaceRos ( )
overridedefault

Destructor.

Member Function Documentation

◆ addEntry()

void state_machine_ros::ReportInterfaceRos::addEntry ( const report::Entry &  entry)
overridevirtual

Reimplemented from state_machine::ReportInterface.

Member Data Documentation

◆ entryPublisher_

ros::Publisher state_machine_ros::ReportInterfaceRos::entryPublisher_
protected

◆ nodeHandle_

ros::NodeHandle& state_machine_ros::ReportInterfaceRos::nodeHandle_
protected

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