dsim_variable_record.h

/*
 *  dsim_variable_record.h
 *  DSimEngine2
 *
 *  Created by David Wilson on 3/17/09.
 *  Copyright 2009 Princeton Satellite Systems. All rights reserved.
 *
 */

#ifndef __DSIM_VARIABLE_RECORD_H__
#define __DSIM_VARIABLE_RECORD_H__

#include <SDManip/SDManip.h>
#include <set>
#include <map>
#include "dsim_variable.h"
class dsim_simulation;
class dsim_integrator;

class dsim_variable_record
{
    public:
        dsim_variable_record(dsim_simulation *sim,dsim_variable::dsim_variable_usage usage,const char *val_name,int data_type,void *init_value,int rows,int cols,const char *units,const char *description);
        ~dsim_variable_record();
    
        void increment(dsim_variable *val);
        void decrement(dsim_variable *val);
        
        inline const char *name() const { return _name; };
        inline const char *units() const { return _units; };
        inline const char *description() const { return _description; };
        inline bool exported() const { return _exported; };
        inline int nominal_rows() const { return _rows; };
        inline int nominal_columns() const { return _cols; };
        
        dsim_variable value(bool force_writable);
        
        void set_attribute(const char *name,const char *value);
        bool has_attribute(const std::string &name);
        std::string get_attribute(const std::string &name);
        std::map<std::string,std::string>::iterator attribute_iterator();
        std::map<std::string,std::string>::iterator end_attribute_iterator();
        
        void start_integration();
        void finish_integration();
    
    private:
        // Type and data
        sd_data_type_manager *_tm;
        int _type;
        sd_type_record *_type_rec;
        void *_ptr;
        void *_cointeg_ptr;
        void *_deriv;
        
        void *base_ptr() { return _ptr; }
        void *cointeg_ptr() { return (_is_integrating&&_cointeg_ptr)?_cointeg_ptr:_ptr; }
                
        // Descriptive elements
        char *_name;
        char *_units;
        char *_description;
        int _rows;
        int _cols;
        dsim_variable::dsim_variable_usage _usage;
        bool _exported;
        bool _telemetry;
        bool _command;
        bool _changed;
        bool _is_integrating;
        
        // Attributes
        std::map<std::string,std::string> attributes;

        // Subscription information
        std::set<dsim_variable *> subscribers;
        
        // Integration Pointer
        void *_integration_ptr;
        
    friend class dsim_variable;
    friend class dsim_integrator;
};

#endif