Class to represent an SQL selection (portion of SELECT clause) for a log message. More...

#include <carma/dbms/LogRecordSelector.h>

Inheritance diagram for carma::dbms::LogRecordSelector:

Classes
struct	SelectionMask
	Holds info on which log record fields should be selected (ie returned) by a query), if a value is set to true, the corresponding field is included in the selection (in cases where if false it is not. More...

Public Member Functions
SelectionMask	getSelectionMask () const
	get the selection mask More...

unsigned	getSupplementalTableJoinCount () const
	returns the number of supplemental tables which will need to be joined to the main monitor table(s) to produce the desired selection <il> More...

	LogRecordSelector ()
	constructor the object is intialized with all the members of its selection mask set to true, except for priorityID More...

SelectionMask	nullSelectionMask () const
	get a selection mask with all fields set to false More...

unsigned	selectedColumnCount () const
	get the number of columns which will be selected based on the selection mask, monitor point data type, and average type More...

void	setCallerMask (bool value)
	Set the mask value for the Caller column of the selection. More...

void	setFrameCountMask (bool value)
	Set the mask value for the Framecount column of the selection. More...

void	setLognameMask (bool value)
	Set the mask value for the Logname column of the selection. More...

void	setMessageMask (bool value)
	Set the mask value for the Message column of the selection. More...

void	setNdcMask (bool value)
	Set the mask value for the ndc column of the selection. More...

void	setPriorityIdMask (bool value)
	Set the mask value for the PriorityID column of the selection. More...

void	setPriorityMask (bool value)
	Set the mask value for the Priority column of the selection. More...

void	setSelectionMask (const SelectionMask &mask)
	set the selection mask More...

std::string	toString () const
	string representation of this selection More...

virtual	~LogRecordSelector ()
	destructor More...

Public Member Functions inherited from carma::dbms::Selector
std::string *	getTable () const
	get the pointer to the table name. More...

void	setTable (const std::string &tableName)
	set the option table name or aliased table name for this selection More...

virtual	~Selector ()
	destructor More...

Protected Member Functions
std::vector< std::string >	selectedColumns_ () const

void	setDefaultSelection_ ()
	set the default selection More...

Protected Attributes
SelectionMask	mask_

Protected Attributes inherited from carma::dbms::Selector
std::string *	tableName_

Detailed Description

Class to represent an SQL selection (portion of SELECT clause) for a log message.

Definition at line 25 of file LogRecordSelector.h.

Constructor & Destructor Documentation

carma::dbms::LogRecordSelector::LogRecordSelector ( )

constructor the object is intialized with all the members of its selection mask set to true, except for priorityID

virtual carma::dbms::LogRecordSelector::~LogRecordSelector ( )

virtual

destructor

Member Function Documentation

SelectionMask carma::dbms::LogRecordSelector::getSelectionMask ( ) const

get the selection mask

unsigned carma::dbms::LogRecordSelector::getSupplementalTableJoinCount ( ) const

returns the number of supplemental tables which will need to be joined to the main monitor table(s) to produce the desired selection <il>

== true => +1

== true && datatype == enumeration => +2

SelectionMask carma::dbms::LogRecordSelector::nullSelectionMask ( ) const

get a selection mask with all fields set to false

Returns: a selection mask with all fields set to false

unsigned carma::dbms::LogRecordSelector::selectedColumnCount ( ) const

get the number of columns which will be selected based on the selection mask, monitor point data type, and average type

Returns: the number of columns which will be selected

void carma::dbms::LogRecordSelector::setCallerMask ( bool value )

Set the mask value for the Caller column of the selection.

Parameters

value The value to set

Definition at line 112 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setDefaultSelection_ ( )

protected

set the default selection

void carma::dbms::LogRecordSelector::setFrameCountMask ( bool value )

Set the mask value for the Framecount column of the selection.

Parameters

value The value to set

Definition at line 121 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setLognameMask ( bool value )

Set the mask value for the Logname column of the selection.

Parameters

value The value to set

Definition at line 130 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setMessageMask ( bool value )

Set the mask value for the Message column of the selection.

Parameters

value The value to set

Definition at line 139 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setNdcMask ( bool value )

Set the mask value for the ndc column of the selection.

Parameters

value The value to set

Definition at line 167 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setPriorityIdMask ( bool value )

Set the mask value for the PriorityID column of the selection.

Parameters

value The value to set

Definition at line 157 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setPriorityMask ( bool value )

Set the mask value for the Priority column of the selection.

Parameters

value The value to set

Definition at line 148 of file LogRecordSelector.h.

void carma::dbms::LogRecordSelector::setSelectionMask ( const SelectionMask & mask )

set the selection mask

Parameters

mask	the selection mask to use

std::string carma::dbms::LogRecordSelector::toString ( ) const

virtual

string representation of this selection

Implements carma::dbms::Selector.

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

carma/dbms/LogRecordSelector.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation