CARMA C++
carma::dbms::MonitorPointSelector::SelectionMask Struct Reference

Holds info on which monitor point fields should be selected (ie returned) by a query), if a value is set to true, the corresponding column is included in the selection (in cases where the selection makes sense, see the description of individual fields), if false it is not. More...

#include <carma/dbms/MonitorPointSelector.h>

Public Attributes

bool blankingFlag
 If true, the blankingFlag column is from the BlankingFlags table is selected. More...
 
bool blankingFlagID
 if true, the blankingFlagID column is selected. More...
 
bool enumString
 If true, the corresponding enumerator string column is selected if the monitor point has data type enumeration. More...
 
bool iSample
 If true, the iSample column is selected. More...
 
bool maxValue
 If true, the maxValue column is selected. More...
 
bool minValue
 If true, the minValue column is selected. More...
 
bool tagID
 If true, the tagID column is selected. More...
 
bool time
 If true, the time column (frameCount for frame and minute averages, integrationID for astronomical integrations) is selected. More...
 
bool validity
 If true, the validity column from the Validities table is selected. More...
 
bool validityID
 If true, the validityID column is selected. More...
 
bool value
 If true, the value column is selected. More...
 

Detailed Description

Holds info on which monitor point fields should be selected (ie returned) by a query), if a value is set to true, the corresponding column is included in the selection (in cases where the selection makes sense, see the description of individual fields), if false it is not.

Definition at line 42 of file MonitorPointSelector.h.

Member Data Documentation

bool carma::dbms::MonitorPointSelector::SelectionMask::blankingFlag

If true, the blankingFlag column is from the BlankingFlags table is selected.

This is the string value corresponding to the blankingFlagID value. A join will have to be done to extract this value. These values are generally more useful to end users than blankingFlagID values. Default setting is true.

Definition at line 80 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::blankingFlagID

if true, the blankingFlagID column is selected.

These values in general are not of much use to end users. Default setting is false.

Definition at line 70 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::enumString

If true, the corresponding enumerator string column is selected if the monitor point has data type enumeration.

In the case where the monitor point is not of type enumeration, setting this field to true is prohibited. Default setting is true if the monitor point is of type enumeration.

Definition at line 116 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::iSample

If true, the iSample column is selected.

In the case of string monitor points, which have no iSample values, setting this field is prohibited. Default setting is true except in the case where the monitor point is of data type string

Definition at line 107 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::maxValue

If true, the maxValue column is selected.

In the case of frame averages and/or string monitor points, which have no maxValue values, setting this field to true is prohibited. In the case of complex monitor points, setting this field to true will cause both parts of the associated value (the maxRealPart and maxImagPart columns) to be selected. Default setting is false.

Definition at line 128 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::minValue

If true, the minValue column is selected.

In the case of frame averages and/or string monitor points, which have no minValue values, setting this field to true is prohibited. In the case of complex monitor points, setting this field to true will cause both parts of the associated value (the minRealPart and minImagPart columns) to be selected. Default setting is false.

Definition at line 140 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::tagID

If true, the tagID column is selected.

Default setting is false.

Definition at line 55 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::time

If true, the time column (frameCount for frame and minute averages, integrationID for astronomical integrations) is selected.

Default setting is true.

Definition at line 49 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::validity

If true, the validity column from the Validities table is selected.

This is the string value corresponding to the validityID value. A join will have to be done to extract this value. These values are generally more useful to end users than validityID values. Default setting is true.

Definition at line 98 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::validityID

If true, the validityID column is selected.

These values in general are not of much use to end users. Default setting is false.

Definition at line 87 of file MonitorPointSelector.h.

bool carma::dbms::MonitorPointSelector::SelectionMask::value

If true, the value column is selected.

In the case of complex values both parts of the value (the realpart and imagpart columns) are selected. Default setting is true.

Definition at line 63 of file MonitorPointSelector.h.


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