Field.h

Go to the documentation of this file.

#ifndef FIELD_H_
#define FIELD_H_

#include "PCSIMException.h"

class SimObject;

#include <string>
using std::string;


class Field
{

public:
    typedef enum { readonly=0, readwrite=1  } AccessType;

    typedef unsigned char ValueType;

    static const ValueType double_t = 0;
    static const ValueType float_t = 1;
    static const ValueType int_t = 2;
    static const ValueType unknown_t = 100;

    Field(void)
    {
        offset = -1;
    };
    virtual ~Field()
    {}
    ;

    virtual Field *clone(void) const = 0;


    string name;

    string description;

    string units;

    AccessType access;

    double lb;

    double ub;

    virtual double getValue( SimObject *o ) const = 0;

    virtual void setValue( SimObject *o, double v ) const = 0;

    int getOffset() const
    {
        return offset;
    };

    ValueType getType() const
    {
        return type;
    }

    static double getValue( void const * const field_ptr, const ValueType &type);
    
    static void setValue(void * const field_ptr, const ValueType &type, const double v);

    void * getPtr( SimObject *o ) const
    {
        return reinterpret_cast<void *>(reinterpret_cast<char *>(o)+offset);
    };

protected:


    int offset;

    int size;

    ValueType type;

};

inline double Field::getValue( void const * const field_ptr, const ValueType &type)
{
    switch (type) {
    case Field::double_t:
        return *(double *)field_ptr;
    case Field::float_t:
        return (float)(*(float *)field_ptr);
    case Field::int_t:
        return (int)(*(int *)field_ptr);
    default:
        /* throw exception */
        throw(
            PCSIM::Exception(
                "static getValue(field_ptr, type)",
                "Cannot get value from an field of an unknwon type.  Only double, float and int fields are supported."
            ) );
    }
}

inline void Field::setValue(void * const field_ptr, const ValueType &type, const double v)
{
    switch (type) {
    case Field::double_t:
        *(double *)field_ptr = v;
        break;
    case Field::float_t:
        (*(float *)field_ptr) = (float)v;
        break;
    case Field::int_t:
        (*(int *)field_ptr) = (int)v;
        break;
    default:
        throw(
            PCSIM::Exception(
                "static setValue(field_ptr, type)",
                "Don't know how to set value to an unknown field type . Only double, float and int fields are supported."
            ) );
    }
}



#endif /*FIELD_H_*/

---