State Machine  0.4.0
This repository contains packages for creating and running general purpose state machines.
state_machine::ReportInterface Class Reference

#include <ReportInterface.hpp>

Inheritance diagram for state_machine::ReportInterface:
Inheritance graph

Public Member Functions

 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)
 
virtual void addEntry (const report::Entry &entry)
 

Detailed Description

Interface to write a report.

Constructor & Destructor Documentation

◆ ReportInterface()

state_machine::ReportInterface::ReportInterface ( )
default

Constructor.

◆ ~ReportInterface()

virtual state_machine::ReportInterface::~ReportInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addEntry()

void state_machine::ReportInterface::addEntry ( const report::Entry &  entry)
virtual

◆ addEntryFailure()

void state_machine::ReportInterface::addEntryFailure ( const State authorState,
const std::string &  message = "",
const bool  isExtendedEntry = true 
)

◆ addEntryNotOk()

void state_machine::ReportInterface::addEntryNotOk ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ addEntryOk()

void state_machine::ReportInterface::addEntryOk ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ addEntryPreempt()

void state_machine::ReportInterface::addEntryPreempt ( const State authorState,
const std::string &  message = "",
const bool  isExtendedEntry = true 
)

◆ addEntryStart()

void state_machine::ReportInterface::addEntryStart ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ addEntrySuccess()

void state_machine::ReportInterface::addEntrySuccess ( const State authorState,
const std::string &  message = "",
const bool  isExtendedEntry = true 
)

◆ addEntryWarning()

void state_machine::ReportInterface::addEntryWarning ( const State authorState,
const std::string &  message = "",
const std::string &  status = "",
const bool  isExtendedEntry = true 
)

◆ createEntry()

report::Entry state_machine::ReportInterface::createEntry ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ createEntryFailure()

report::Entry state_machine::ReportInterface::createEntryFailure ( const State authorState,
const std::string &  message = "",
const bool  isExtendedEntry = true 
)

◆ createEntryNotOk()

report::Entry state_machine::ReportInterface::createEntryNotOk ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ createEntryOk()

report::Entry state_machine::ReportInterface::createEntryOk ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ createEntryPreempt()

report::Entry state_machine::ReportInterface::createEntryPreempt ( const State authorState,
const std::string &  message = "",
const bool  isExtendedEntry = true 
)

◆ createEntryStart()

report::Entry state_machine::ReportInterface::createEntryStart ( const State authorState,
const bool  isExtendedEntry = true 
)

◆ createEntrySuccess()

report::Entry state_machine::ReportInterface::createEntrySuccess ( const State authorState,
const std::string &  message = "",
const bool  isExtendedEntry = true 
)

◆ createEntryWarning()

report::Entry state_machine::ReportInterface::createEntryWarning ( const State authorState,
const std::string &  message = "",
const std::string &  status = "",
const bool  isExtendedEntry = true 
)

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