SignalLogger
A library for signal logging.
signal_logger::LogElementOptions Class Reference

#include <LogElementOptions.hpp>

Public Member Functions

 LogElementOptions (const std::string &name, const std::string &unit, const std::size_t divider, const LogElementAction action)
 
 LogElementOptions (const LogElementOptions &other)
 
void transfer (const LogElementOptions &other)
 
std::string getName () const
 
std::string getUnit () const
 
std::size_t getDivider () const
 
void setDivider (const std::size_t divider)
 
LogElementAction getAction () const
 
void setAction (const LogElementAction action)
 
bool isPublished () const
 
bool isSaved () const
 

Private Attributes

const std::string name_
 Name of the log element. More...
 
const std::string unit_
 Unit of the log element. More...
 
std::atomic_size_t divider_
 Defines log element collection frequency = updateFrequency/divider. More...
 
std::atomic< LogElementActionaction_
 Action. More...
 

Constructor & Destructor Documentation

signal_logger::LogElementOptions::LogElementOptions ( const std::string &  name,
const std::string &  unit,
const std::size_t  divider,
const LogElementAction  action 
)
inline

Constructor

Parameters
namename of the log var
unitunit of the log var
dividerlog_freq = ctrl_freq/divider
actionsave, publish or save and publish
signal_logger::LogElementOptions::LogElementOptions ( const LogElementOptions other)
inline

Member Function Documentation

LogElementAction signal_logger::LogElementOptions::getAction ( ) const
inline
std::size_t signal_logger::LogElementOptions::getDivider ( ) const
inline
std::string signal_logger::LogElementOptions::getName ( ) const
inline
std::string signal_logger::LogElementOptions::getUnit ( ) const
inline
bool signal_logger::LogElementOptions::isPublished ( ) const
inline
Returns
check action for publishing
bool signal_logger::LogElementOptions::isSaved ( ) const
inline
Returns
check action for saving
void signal_logger::LogElementOptions::setAction ( const LogElementAction  action)
inline
void signal_logger::LogElementOptions::setDivider ( const std::size_t  divider)
inline
void signal_logger::LogElementOptions::transfer ( const LogElementOptions other)
inline

Member Data Documentation

std::atomic<LogElementAction> signal_logger::LogElementOptions::action_
private

Action.

std::atomic_size_t signal_logger::LogElementOptions::divider_
private

Defines log element collection frequency = updateFrequency/divider.

const std::string signal_logger::LogElementOptions::name_
private

Name of the log element.

const std::string signal_logger::LogElementOptions::unit_
private

Unit of the log element.


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