UniversalURI.h

Go to the documentation of this file.

#ifndef UNIVERSALURI_H_
#define UNIVERSALURI_H_

#include "utils/Str.h"
//#include "logger/Logger.h"

#include "ElementURI.h"

class Logger;
class UniversalBlobURI;

class UniversalURI : public ElementURI //, public DataIF
{
public:

    virtual ~UniversalURI();

    static UniversalURI* FindURI( const Str& name );

    static UniversalURI* FindURI( const char* candidate );

    virtual bool isUniversal() const
    {
        return true;
    }

    static const Str NAME;

    /*static const UniversalURI NONE;*/

    static const UniversalURI ACOUSTIC_RECEIVE_TIME;

    static const UniversalURI ACOUSTIC_TRANSMIT_TIME;

    static const UniversalURI DEPTH;

    static const UniversalURI DEPTH_RATE;

    static const UniversalURI DIRECTION_OF_SEA_WATER_VELOCITY;

    static const UniversalURI DISTANCE_FROM_SHORE;

    static const UniversalURI DOWNWELLING_PHOTOSYNTHETIC_PHOTON_FLUX_IN_SEA_WATER;

    static const UniversalURI DOWNWARD_SEA_WATER_VELOCITY;

    static const UniversalURI EASTWARD_SEA_WATER_VELOCITY;

//    static const UniversalURI ELAPSED_TIME_SINCE_ORIENTATION_READ;
//    static const UniversalURI ELAPSED_TIME_SINCE_VELOCITY_READ;

    static const UniversalURI FIX_DISTANCE_MADE_GOOD;

    static const UniversalURI FIX_HORIZONTAL_PATH_LENGTH_SINCE_LAST_FIX;

    static const UniversalURI FIX_RESIDUAL_DISTANCE;

    static const UniversalURI FIX_RESIDUAL_BEARING;

    static const UniversalURI FIX_RESIDUAL_PERCENT_DISTANCE_TRAVELED;

    static const UniversalURI GRID_LATITUDE;

    static const UniversalURI GRID_LONGITUDE;

    static const UniversalURI HEIGHT_ABOVE_SEA_FLOOR;

    static const UniversalURI HORIZONTAL_PATH_LENGTH_SINCE_LAST_FIX;

    static const UniversalURI LATITUDE;

    static const UniversalURI LATITUDE_FIX;

    static const UniversalBlobURI LOCATION_FIX;

    static const UniversalURI LONGITUDE;

    static const UniversalURI LONGITUDE_FIX;

    static const UniversalURI MISSION_STARTED;

    static const UniversalURI MASS_CONCENTRATION_OF_CHLOROPHYLL_IN_SEA_WATER;

    static const UniversalURI MASS_CONCENTRATION_OF_OXYGEN_IN_SEA_WATER;

    static const UniversalURI MOLE_CONCENTRATION_OF_NITRATE_IN_SEA_WATER;

    static const UniversalURI NORTHWARD_SEA_WATER_VELOCITY;

    // Current taken from Onboard A/D and averaged over n number of samples
    static const UniversalURI PLATFORM_AVERAGE_CURRENT;

    static const UniversalURI PLATFORM_BATTERY_CHARGE;

    static const UniversalURI PLATFORM_BATTERY_CHARGE_USAGE;

    static const UniversalURI PLATFORM_BATTERY_ENERGY_USAGE;

    static const UniversalURI PLATFORM_BATTERY_VOLTAGE;

    // True == battery or batteries are discharging. False == no battery is discharging
    static const UniversalURI PLATFORM_BATTERY_DISCHARGING;

    // True == all batteries are fully charged. False == not all batteries are fully charged
    static const UniversalURI PLATFORM_BATTERY_FULLY_CHARGED;

    static const UniversalURI PLATFORM_BUOYANCY_POSITION;

    static const UniversalURI PLATFORM_COMMUNICATIONS;

    static const UniversalURI PLATFORM_CONVERSATION;

    static const UniversalURI PLATFORM_COURSE;

    static const UniversalURI PLATFORM_DISTANCE_WRT_GROUND;

    static const UniversalURI PLATFORM_DISTANCE_WRT_SEA_WATER;

    static const UniversalURI PLATFORM_ELEVATOR_ANGLE;

    static const UniversalURI PLATFORM_FAULT;

    static const UniversalURI PLATFORM_FAULT_LEAK;

    static const UniversalURI PLATFORM_MAGNETIC_ORIENTATION;

    static const UniversalURI PLATFORM_MASS_POSITION;

    static const UniversalURI PLATFORM_ORIENTATION;

    static const UniversalBlobURI PLATFORM_ORIENTATION_MATRIX;

    static const UniversalURI PLATFORM_PITCH_ANGLE;

    static const UniversalURI PLATFORM_PITCH_RATE;

    //static const UniversalURI PLATFORM_POSITION_VECTOR;

    static const UniversalURI PLATFORM_PRESSURE;

    static const UniversalURI PLATFORM_PROPELLER_ROTATION_RATE;

    //static const UniversalURI PLATFORM_RATE_VECTOR;

    static const UniversalURI PLATFORM_RELATIVE_HUMIDITY;

    static const UniversalURI PLATFORM_ROLL_ANGLE;

    static const UniversalURI PLATFORM_ROLL_RATE;

    static const UniversalURI PLATFORM_RUDDER_ANGLE;

    static const UniversalURI PLATFORM_SPEED_WRT_GROUND;

    static const UniversalURI PLATFORM_SPEED_WRT_SEA_WATER;

    static const UniversalURI PLATFORM_SPEED_WRT_PROPELLER;

    static const UniversalURI PLATFORM_TEMPERATURE;

    static const UniversalBlobURI PLATFORM_VELOCITY_WRT_GROUND;

    static const UniversalBlobURI PLATFORM_VELOCITY_WRT_SEA_WATER;


    static const UniversalURI PLATFORM_X_SEA_WATER_VELOCITY;

    static const UniversalURI PLATFORM_X_VELOCITY_WRT_GROUND;

    static const UniversalURI PLATFORM_X_VELOCITY_WRT_SEA_WATER;

    static const UniversalURI PLATFORM_X_VELOCITY_CURRENT;

    static const UniversalURI PLATFORM_Y_SEA_WATER_VELOCITY;

    static const UniversalURI PLATFORM_Y_VELOCITY_WRT_GROUND;

    static const UniversalURI PLATFORM_Y_VELOCITY_WRT_SEA_WATER;

    static const UniversalURI PLATFORM_Y_VELOCITY_CURRENT;

    static const UniversalURI PLATFORM_YAW_ANGLE;

    static const UniversalURI PLATFORM_YAW_RATE;

    static const UniversalURI PLATFORM_Z_SEA_WATER_VELOCITY;

    static const UniversalURI PLATFORM_Z_VELOCITY_WRT_GROUND;

    static const UniversalURI PLATFORM_Z_VELOCITY_WRT_SEA_WATER;

    static const UniversalURI PLATFORM_Z_VELOCITY_CURRENT;

    static const UniversalURI PROJECTION_X_COORDINATE;

    static const UniversalURI PROJECTION_Y_COORDINATE;

    static const UniversalURI PROJECTION_ZONE;

    static const UniversalURI SEA_FLOOR_DEPTH_BELOW_GEOID;

    static const UniversalURI SEA_WATER_DENSITY;

    static const UniversalURI SEA_WATER_ELECTRICAL_CONDUCTIVITY;

    static const UniversalURI SEA_WATER_POTENTIAL_DENSITY;

    static const UniversalURI SEA_WATER_POTENTIAL_TEMPERATURE;

    static const UniversalURI SEA_WATER_PRESSURE;

    static const UniversalURI SEA_WATER_RHODAMINE;

    static const UniversalURI SEA_WATER_SALINITY;

    static const UniversalURI SEA_WATER_SIGMA_T;

    static const UniversalURI SEA_WATER_SIGMA_THETA;

    static const UniversalURI SEA_WATER_SPEED;

    static const UniversalURI SEA_WATER_TEMPERATURE;

    static const UniversalURI SURFACE_EASTWARD_SEA_WATER_VELOCITY;

    static const UniversalURI SURFACE_NORTHWARD_SEA_WATER_VELOCITY;

    static const UniversalURI TIME;

    static const UniversalURI TIME_FIX;

    static const UniversalURI UPWARD_DERIVATIVE_OF_SEA_WATER_TEMPERATURE;

    static const UniversalURI VOLUME_BACKWARDS_SCATTERING_COEFFICIENT_OF_RADIATIVE_FLUX_IN_SEA_WATER;

protected:

    friend class ElementURI;
    friend class ReadDataComponent;
    friend class Slate;

    UniversalURI( unsigned short code, const char* fullURI,
                  const Unit& unit = UNSPECIFIED_UNIT, BinaryDataType binaryType = NO_TYPE,
                  BlobType blobType = NOT_BLOB, unsigned short dimension1 = 0,
                  unsigned short dimension2 = 0, unsigned short dimension3 = 0 );

    UniversalURI( const char* fullURI,
                  const Unit& unit = UNSPECIFIED_UNIT, BinaryDataType binaryType = NO_TYPE,
                  BlobType blobType = NOT_BLOB, unsigned short dimension1 = 0,
                  unsigned short dimension2 = 0, unsigned short dimension3 = 0 );

};

class UniversalBlobURI: public UniversalURI
{
public:
    virtual ~UniversalBlobURI() {}

protected:

    friend class ElementURI;
    friend class UniversalURI;

    UniversalBlobURI( unsigned short code, const char* fullURI, const Unit& unit = UNSPECIFIED_UNIT,
                      BlobType blobType = NOT_BLOB, unsigned short dimension1 = 0,
                      unsigned short dimension2 = 0, unsigned short dimension3 = 0 );

    UniversalBlobURI( const char* fullURI, const Unit& unit,
                      BlobType blobType, unsigned short dimension1 = 0,
                      unsigned short dimension2 = 0, unsigned short dimension3 = 0 );

};


#endif /*UNIVERSALURI_H_*/