CARMA C++
carma::monitor::ThresholdFileWriter Class Reference

A class that will allow you to write out the set threshold values for the monitor system into an xml file. More...

#include <carma/monitor/ThresholdFileWriter.h>

Public Member Functions

void createXmlFile ()
 creates the xml file by iterating through the monitor points More...
 
 ThresholdFileWriter (MonitorSystem &system)
 

Protected Member Functions

void addPoint (const MonitorPoint &point, const MonitorPointThreshold &threshold)
 method for writing out [Monitor/Sense/Control]Point information More...
 
void createEndTag (bool needIndent=true)
 create end tag for the xml More...
 
void createStartTag (const std::string &tagName, const std::map< std::string, std::string > &attributes, bool includeEndl=true)
 create the start tag for the xml More...
 

Detailed Description

A class that will allow you to write out the set threshold values for the monitor system into an xml file.

Definition at line 27 of file ThresholdFileWriter.h.

Member Function Documentation

void carma::monitor::ThresholdFileWriter::addPoint ( const MonitorPoint point,
const MonitorPointThreshold &  threshold 
)
protected

method for writing out [Monitor/Sense/Control]Point information

Parameters
pointmonitor point object
thresholdthreshold object for point
void carma::monitor::ThresholdFileWriter::createEndTag ( bool  needIndent = true)
protected

create end tag for the xml

Parameters
needIndentboolean used if end tag is on a new line (set false if <tag>value</tag> format is desired)
void carma::monitor::ThresholdFileWriter::createStartTag ( const std::string &  tagName,
const std::map< std::string, std::string > &  attributes,
bool  includeEndl = true 
)
protected

create the start tag for the xml

Parameters
tagNamename of the tag (Subsystem/Container/MonitorPoint/etc)
attributestag attributes
includeEndlboolean inquiring whether to add the endl or not (in case the entire <tag>value</tag> should go on one line)
void carma::monitor::ThresholdFileWriter::createXmlFile ( )

creates the xml file by iterating through the monitor points


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