MonitorConfigurationDatabase.h

Go to the documentation of this file.

#ifndef CARMA_DBMS_MONITORCONFIGURATIONDATABASE_H
#define CARMA_DBMS_MONITORCONFIGURATIONDATABASE_H

#include <map>
#include "carma/dbms/Table.h"
#include "carma/dbms/ColumnNames.h"
#include "carma/dbms/Typedefs.h"
#include "carma/util/Logger.h"
#include "carma/util/Time.h"

namespace carma {
namespace dbms {

    class DBConnection;
    class MonitorDescription;

class MonitorConfigurationDatabase {

public:
    explicit MonitorConfigurationDatabase( const DBConnection * dbc );

    //--------------- Subsystems table access methods --------------------

    void populateSubsystemsTable( ) const;

    short getSubsystemID( const ::std::string & subsysName, 
                          bool                  ignoreCase = false ) const;

    ::std::string * getSubsystemName( unsigned short subsysID ) const;

    dbms::Table getSubsystemsTable( ) const;

    //-------------- AggregateSubsystems table access methods -------------
    
    void insertAggregateSubsystemsRecord(
        const ::std::string & name,
        unsigned                  count,
        unsigned                  maxsamples,
        unsigned                  maxpoints ) const;

    dbms::Table getAggregateSubsystemsTable( ) const;

    unsigned getTotalMaxPoints( ) const;

    unsigned getTotalMaxSamples( ) const;

    //--------------- Locations table access methods --------------------
    void populateLocationsTable( ) const;

    dbms::Table getLocationsTable( ) const;

    //--------------- Devices table access methods --------------------
    void populateDevicesTable( ) const;

    dbms::Table getDevicesTable( ) const;

    unsigned insertMonitorConfiguration(
        const MonitorDescription & md,
        bool  updateOnlyIfNecessary = true ) const;

    unsigned insertMonitorConfiguration(
        const MonitorDescription & Md,
        ::std::string &msg,
        bool updateOnlyIfNecessary = true,
        bool noInsertDenied=false ) const;

    bool mutateStaticParms(const ::std::string &disposition,
                           unsigned tagID, const ::std::string &mpName,
                           const ::std::string &fieldName,
                           const ::std::string &newValue,
                           const ::std::string &requester);

    bool mutateStaticParms(const ::std::string &changeString);

    MonitorDescription getMonitorConfiguration(
        const ::std::string & canonicalName,
        util::frameType       frameCount =
            util::Time::computeCurrentFrame( ) ) const;


    dbms::Table getFullMonitorConfigurationTable(
        const ::std::vector< int > * const tagIDs = 0,
        bool                               retreiveOnlyValidConfigs = false,
        util::frameType                    frameCount =
            util::Time::computeCurrentFrame( ) ) const;


    dbms::ID2MDMap getMonitorConfigurations(
        const ::std::vector< int > * tagIDs,
        util::frameType              frameCount =
            util::Time::computeCurrentFrame( ) ) const;

    MonitorDescription getMonitorConfiguration(
        int             tagID,
        util::frameType frameCount = util::Time::computeCurrentFrame( ) ) const;

    unsigned getMaxTagID( unsigned short subsysID ) const;

    bool tagIDExists( int tagID ) const;

    void getContainerAndMPNames( const char *    hname,
                                 ::std::string & cname, 
                                 ::std::string & mpname) const;

    ::std::map< int, ::std::string > getTagID2NameMap( ) const;

    dbms::Table getTagIDToDataTypeIDTable( ) const;


    ::std::string getCanonicalName( const int tagID ) const;

    ::std::string getCanonicalName( const ::std::string & tagID ) const;

    int getTagID( const ::std::string & mpName ) const;

    //dbms::Column<int> getTagIDs
    //(const ::std::vector<::std::string>* const canonicalNames=0) const;

    ::std::map< int, ::std::string > getTagIDs(
        const ::std::string & wildcardedName, 
        const ::std::string & multiCharacterWildcard = "%",
        const ::std::string & singleCharacterWildcard = "_" ) const;
         
    bool monitorConfigExists( const ::std::string & canonicalName ) const;

    void populateValiditiesTable( ) const;

    dbms::Table getValiditiesTable( ) const;

    void populateBlankingFlagsTable( ) const;

    dbms::Table getBlankingFlagsTable( ) const;

    void populateMonitorPointDataTypesTable( ) const;

    dbms::Table getMonitorPointDataTypesTable( ) const;

    void populateMonitorPointTypesTable( ) const;

    dbms::Table getMonitorPointTypesTable( ) const;


    dbms::MonitorDescription tableRow2MonitorDescription(
        const dbms::Table & t,
        int                 row ) const;

    //static unsigned shortNameMaxLength() { return 64; }

    bool insertTagIDNameSignaturesRecord(
        util::frameType       frameCount, 
        const ::std::string & signature,
        bool                  updateOnlyIfNecessary = true ) const;

    dbms::Table getTagIDNameSignatures(
        const dbms::DBColumn * orderBy,
        dbms::SortOrder        sortOrder = dbms::DESCENDING ) const;

    ::std::string * getCurrentTagIDNameSignature( ) const;

    ::std::string * getTagIDNameSignature(
        util::frameType frameCount= util::Time::computeCurrentFrame( ) ) const;


private:

    void setEnumerators_( int                        tagID,
                          const ::std::string &      name,
                          dbms::MonitorDescription & md ) const;


    void getEnumerators_( unsigned                            tagID,
                          const ::std::string *           name,
                          dbms::Column< ::std::string > & enumValues, 
                          dbms::Column< ::std::string > & enumDescriptions, 
                          dbms::Column< short > &         enumIndices ) const;


    void insertEnumerators_( unsigned                             tagID, 
                             const dbms::MonitorDescription & md ) const;

    /********************************************************************/
    /*          Routines to support editing of static fields.           */
    bool mutateEnumerator(
     const MonitorDescription &existingMD,
     carma::util::frameType frameCount,
     unsigned tagID, const std::string &mpName,
     const std::string &fieldName, const std::string &newValue,
     const std::string &username);

    /* Get max version # for this monitor point. */
    int getMaxVersionNumber(const std::string &mpname) const;

    bool makeNewMPVersion(const MonitorDescription &md,
                          carma::util::frameType frameCount,
                          unsigned tagID, const ::std::string &mpName,
                          const ::std::string &userName);


    /* Make an entry in the static parameter change log table indicating
     * what was done.
     * This is usually called from within the same try/catch block that
     * contains the SQL command changing the database.
     * This is only called by the mutate routines and is used to keep
     * track of potentially dangerous changes.
     */
    void makeStaticParamChangeLogEntry(carma::util::frameType frameCount,
        unsigned tagID,
        const ::std::string &mpname, const ::std::string &fieldname,
        const ::std::string &newValue, const ::std::string &oldValue,
        const ::std::string &userName, int index=0);
    /********************************************************************/

    bool getEnumID(const ::std::string &enumName,
                   const ::std::string &description,
                   int &enumID);
    short getLocationID_( const ::std::string & locationName, 
                          bool                  ignoreCase = false ) const;

    ::std::string * getLocationName_( unsigned short locationID ) const;

    short getDeviceID_( const ::std::string & deviceName, 
                        bool                  ignoreCase = false ) const;

    ::std::string * getDeviceName_( unsigned short deviceID ) const;


    const DBConnection * dbc_;
    log4cpp::Category &  logger_;
};


}
}


#endif // CARMA_DBMS_MONITORCONFIGURATIONDATABASE_H