DataValue.h

Go to the documentation of this file.

#ifndef DATAVALUE_H_
#define DATAVALUE_H_

#include "data/BinaryDataType.h"
#include "units/Unit.h"
#include "utils/Str.h"

class OutStream;

class DataValue
{

    friend class DataAccess;

public:

    virtual ~DataValue()
    {}
    ;

    void operator delete( void* p );

    virtual DataValue* copy() const = 0;

    virtual void minus( const DataValue* rhs, DataValue* assignTo ) const = 0;

    virtual void times( const double rhs, DataValue* assignTo ) const = 0;

    virtual double absDiff( const DataValue* rhs ) const = 0;

    virtual bool copyTo( const Unit& unit, bool& assignTo ) const;

    virtual bool copyTo( const Unit& unit, unsigned char& assignTo ) const = 0;

    virtual bool copyTo( const Unit& unit, double& assignTo ) const = 0;

    virtual bool copyTo( const Unit& unit, float& assignTo ) const = 0;

    virtual bool copyTo( const Unit& unit, int& assignTo ) const = 0;

    virtual bool copyTo( DataValue& assignTo ) const
    {
        return assignTo.setFrom( *this );
    }

    virtual int compare( const Unit& unit, const bool& compareTo ) const;

    virtual int compare( const Unit& unit, const unsigned char& compareTo ) const = 0;

    virtual int compare( const Unit& unit, const double& compareTo ) const = 0;

    virtual int compare( const Unit& unit, const float& compareTo ) const = 0;

    virtual int compare( const Unit& unit, const int& compareTo ) const = 0;

    virtual int compare( const DataValue& compareTo ) const = 0;

    virtual bool equals( const Unit& unit, const bool& compareTo ) const;

    virtual bool equals( const Unit& unit, const unsigned char& compareTo ) const = 0;

    virtual bool equals( const Unit& unit, const double& compareTo ) const = 0;

    virtual bool equals( const Unit& unit, const float& compareTo ) const = 0;

    virtual bool equals( const Unit& unit, const int& compareTo ) const = 0;

    virtual bool equals( const DataValue& compareTo ) const = 0;

    virtual bool isNaN()
    {
        return false;
    }

    virtual bool setFrom( const Unit& unit, bool value );

    virtual bool setFrom( const Unit& unit, unsigned char value ) = 0;

    virtual bool setFrom( const Unit& unit, double value ) = 0;

    virtual bool setFrom( const Unit& unit, float value ) = 0;

    virtual bool setFrom( const Unit& unit, int value ) = 0;

    virtual bool setFrom( const DataValue& value ) = 0;

    // as a Str
    virtual Str toString( const Unit& unit ) const = 0;

    // as a Str with its unit
    virtual Str toString() const
    {
        return toString( getUnit() ) + " " + getUnit().getAbbreviation();
    }

    virtual unsigned int toStream( OutStream& outStream ) const = 0;

    virtual void fromBinary( const void *buffer ) = 0;

    virtual size_t getTypeSize() const
    {
        return typeSize_;
    }

    virtual BinaryDataType getBinaryType( void ) const
    {
        return binaryType_;
    }

    const Unit& getUnit() const
    {
        return *unit_;
    }

    const Unit& getBaseUnit() const
    {
        return unit_->getBaseUnit();
    }

    void setUnit( const Unit& unit )
    {
        unit_ = &unit;
    }

    void clearType()
    {
        binaryType_ = NO_TYPE;
    }

protected:

    DataValue( const Unit& unit, const size_t& typeSize, const BinaryDataType& binaryType )
        : unit_( &unit ),
          typeSize_( typeSize ),
          binaryType_( binaryType )
    {}
    ;

    DataValue( const size_t& typeSize, const BinaryDataType& binaryType )
        : unit_( NULL ),
          typeSize_( typeSize ),
          binaryType_( binaryType )
    {}
    ;

    // The base "ancestor" unit of the value stored in this DataValue
    // All values that are read to/from this DataValue must be convertable
    // to this unit.
    const Unit* unit_;

    size_t typeSize_;

    BinaryDataType binaryType_;

private:
    // Note that the copy constructor below is private and not given a body.
    // Any attempt to call it will return a compiler error.
    DataValue( const DataValue& old ); // disallow copy constructor};

};

#endif /*DATAVALUE_H_*/