MonitorPointSelector.h

Go to the documentation of this file.

#ifndef CARMA_DBMS_MONITORPOINTSELECTOR_H
#define CARMA_DBMS_MONITORPOINTSELECTOR_H

#include <string>
#include "carma/dbms/ColumnNames.h"
#include "carma/dbms/MonitorDescription.h"
#include "carma/dbms/MonitorSystemAndDBMSRelationships.h"
#include "carma/dbms/Selector.h"

namespace carma {
namespace dbms {

    class DBConnection;

class MonitorPointSelector : public Selector {

public:

    //friend class MonitorDataQueryManager;

    typedef struct {
        bool time;
        bool tagID;
        bool value;
        bool blankingFlagID;
        bool blankingFlag;
        bool validityID;
        bool validity;
        bool iSample;
        bool enumString;
        bool maxValue;
        bool minValue;
    } SelectionMask;

    MonitorPointSelector(const unsigned& tagID, 
                         const carma::dbms::DBConnection* const dbc);

    MonitorPointSelector(const unsigned& tagID, 
                         carma::dbms::MonitorPointDataType dataType);

    ~MonitorPointSelector();

    unsigned getTagID() const { return tagID_; }

    void setSelectionMask(const SelectionMask& mask, bool quietly=false);

    void setSelectionMask(const std::string &maskString);

    SelectionMask getSelectionMask() const;

    carma::dbms::MonitorDescription getMonitorConfiguration() const;

    std::string toString() const;

    std::string toString
        (const carma::dbms::MonitorAverageType& avgType, 
         const std::string& table="", 
         const std::string& columnAliasPrepender="",
         const std::string& blankingFlagTableAlias="",
         const std::string& validityTableAlias="",
         const std::string& enumIndexTableAlias="", 
         const bool& onlyAliases=false) 
        const;


    void setColumnPrefix(const std::string& columnPrefix) {
        columnPrefix_ = columnPrefix;
    }

    std::string getColumnPrefix() const { return columnPrefix_; }

    bool doSelectEnumString() const;

    unsigned getSupplementalTableJoinCount() const;

    unsigned selectedColumnCount(carma::dbms::MonitorAverageType& avgType) const;

    MonitorPointDataType getDataType() const { return dataType_; }

    void selectOnlyTagID();

    SelectionMask nullSelectionMask() const;

    SelectionMask allSelectionMask() const;
 
protected:
    unsigned tagID_;
    // make this a pointer since the default MonitorDescription constructor 
    // is protected
    MonitorDescription *md_;
    SelectionMask mask_;
    //carma::dbms::MonitorAverageType avgType_;
    carma::dbms::MonitorPointDataType dataType_;
    std::string columnPrefix_;

    void setDefaultSelection_();

    static std::string getModifiedColumnSelection_
        (const carma::dbms::DBColumn& columnName, const std::string& table, 
         const std::string& alias, const bool& onlyAlias);

    std::vector<std::string> selectedColumns_
        (const carma::dbms::MonitorAverageType& avgType, 
         const std::string& table="", 
         const std::string& columnAliasPrepender="",
         const std::string& blankingFlagTableAlias="",
         const std::string& validityTableAlias="", 
         const std::string& enumIndexTableAlias="", 
         const bool& onlyAliases=false) const;
};

class MPSelectorCompare
{
    public:
    bool operator()
        (const MonitorPointSelector* lhs, const MonitorPointSelector* rhs) ; 
};

typedef std::set<MonitorPointSelector*, MPSelectorCompare> MPSelectorSet;

}}

#endif // CARMA_DBMS_MONITORPOINTSELECTOR_H