carma::ui::dbms::MonitorDataExtractor Class Reference

Class for extracting monitor data from the DBMS. More...

#include <carma/ui/dbms/MonitorDataExtractor.h>

Inheritance diagram for carma::ui::dbms::MonitorDataExtractor:

Public Member Functions
void	addMonitorPoint (const std::string &mpName)
	Adds a single monitor point to the search criteria for the DBMS. More...
void	addMonitorPoints (const std::string &mpName, const std::string &multiWildcard, const std::string &singleWildcard)
	Add multiple monitor points using wildcard characters. More...
void	addMonitorPoints (const std::string &mpName, const std::string &multiWildcard, const std::string &singleWildcard, const std::string &selectionMask)
void	clearPreviousQuery ()
	Clears query that was set up for MonitorDataExtractor. More...
std::string	getCanonicalName (const std::string &tagId)
	Return the canonical name for a given tagId. More...
std::string	getCanonicalName (const int tagId)
	Return the canonical name for a given tagId. More...
carma::dbms::Table	getTableOfAllMps ()
	get monitor points from dbms, where all monitor points are put into a single Table More...
std::map< int, carma::dbms::Table >	getTablePerMp ()
	get monitor points from dbms, where each monitor point occupies a single Table More...
	MonitorDataExtractor (const std::string &dbConfFile)
void	setFilter ()
	(note: not implemented yet) this member function should set up filters used for monitor points (see carma::dbms::MonitorDataQueryManager). More...
void	setTimeRange (const int &beginTime, const int &endTime, const carma::dbms::MonitorAverageType &averageType=carma::dbms::FRAME_AVG, const bool &includeTime1=false, const bool &includeTime2=false, const carma::dbms::TimeFilter::TimeColumnType colType=carma::dbms::TimeFilter::FRAMECOUNT)
	set the time range for finding monitor points More...
Public Member Functions inherited from carma::ui::dbms::DataExtractor
	DataExtractor (const std::string &dbConfFile)

Additional Inherited Members
Protected Attributes inherited from carma::ui::dbms::DataExtractor
carma::dbms::DBConnection *	dbConnection_

Detailed Description

Class for extracting monitor data from the DBMS.

Definition at line 45 of file MonitorDataExtractor.h.

Member Function Documentation

void carma::ui::dbms::MonitorDataExtractor::addMonitorPoint

(

const std::string &

mpName

)

Adds a single monitor point to the search criteria for the DBMS.

Parameters

mpName

canonical name for Monitor Point to add to search

void carma::ui::dbms::MonitorDataExtractor::addMonitorPoints	(	const std::string &	mpName,
		const std::string &	multiWildcard,
		const std::string &	singleWildcard
	)

Add multiple monitor points using wildcard characters.

Parameters

mpName	canonical name of Monitor Point(s) using a wildcards
multiWildcard	wildcard character used to specify multiple characters
singleWildcard	wildcard character used to specify a single character
selectionMask	string containing selection values.

void carma::ui::dbms::MonitorDataExtractor::clearPreviousQuery

(

)

Clears query that was set up for MonitorDataExtractor.

std::string carma::ui::dbms::MonitorDataExtractor::getCanonicalName

(

const std::string &

tagId

)

Return the canonical name for a given tagId.

Parameters

tagId

tag ID in string form for monitor point

std::string carma::ui::dbms::MonitorDataExtractor::getCanonicalName

(

const int

tagId

)

Return the canonical name for a given tagId.

Parameters

tagId

tag ID in int form for monitor point

carma::dbms::Table carma::ui::dbms::MonitorDataExtractor::getTableOfAllMps

(

)

get monitor points from dbms, where all monitor points are put into a single Table

std::map<int, carma::dbms::Table> carma::ui::dbms::MonitorDataExtractor::getTablePerMp

(

)

get monitor points from dbms, where each monitor point occupies a single Table

void carma::ui::dbms::MonitorDataExtractor::setFilter

(

)

(note: not implemented yet) this member function should set up filters used for monitor points (see carma::dbms::MonitorDataQueryManager).

setFilters_ variable will then be passed into the MDQM constructor.

void carma::ui::dbms::MonitorDataExtractor::setTimeRange	(	const int &	beginTime,
		const int &	endTime,
		const carma::dbms::MonitorAverageType &	averageType = carma::dbms::FRAME_AVG,
		const bool &	includeTime1 = false,
		const bool &	includeTime2 = false,
		const carma::dbms::TimeFilter::TimeColumnType	colType = carma::dbms::TimeFilter::FRAMECOUNT
	)

set the time range for finding monitor points

Parameters

beginTime	begin time (in units of frame count) for search
endTime	end time (in units of frame count) for search
averageType	the type of average to consider
includeTime1	include time1 in the range (adds an "=" to the test)?
includeTime1	include time2 in the range (adds an "=" to the test)?
colType	the time identifier column type

Exceptions

TimeFilterException

if colType==carma::dbms::TimeFilter::INTEGRATIONID and (averageType == FRAME_AVG or MINUTE_AVG)

See Also

carma::dbms::TimeRangeFilter

---

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

• carma/ui/dbms/MonitorDataExtractor.h