regionparams.h

Go to the documentation of this file.

//************************************************************************
//                                                                      *
//           Copyright (C)  2004                                        *
//     University Corporation for Atmospheric Research                  *
//           All Rights Reserved                                        *
//                                                                      *
//************************************************************************/
//
//  File:       regionparams.h
//
//  Author:     Alan Norton
//          National Center for Atmospheric Research
//          PO 3000, Boulder, Colorado
//
//  Date:       September 2004
//
//  Description:    Defines the RegionParams class.
//      This class supports parameters associted with the
//      region panel, describing the rendering region
//
#ifndef REGIONPARAMS_H
#define REGIONPARAMS_H


#include <vector>
#include <map>
#include <vapor/common.h>
#include "params.h"
#include <vapor/MyBase.h>


using namespace VetsUtil;

namespace VAPoR {

class ViewpointParams;
class XmlNode;
class ParamNode;
class PARAMS_API RegionParams : public Params {
    
public: 
    RegionParams(XmlNode* parent, int winnum);

    ~RegionParams();
    virtual void Validate(int type);
    virtual void restart();
    static ParamsBase* CreateDefaultInstance() {return new RegionParams(0, -1);}

    const std::string getShortName() {return _shortName;}
    
    virtual Box* GetBox() {
        vector<string>path;
        path.push_back(Box::_boxTag);
        return (Box*) GetParamsBase(path);
    }
    
    double getLocalRegionMin(int coord, int timestep){ 
        double exts[6];
        GetBox()->GetLocalExtents(exts, timestep);
        return exts[coord];
    }
    double getLocalRegionMax(int coord, int timestep){ 
        double exts[6];
        GetBox()->GetLocalExtents(exts, timestep);
        return exts[coord+3];
    }
    
    void getLocalRegionExtents(double exts[6],int timestep){
        GetBox()->GetLocalExtents(exts,timestep);
        return;
    }
    double getLocalRegionCenter(int indx, int timestep) {
        return (0.5*(getLocalRegionMin(indx,timestep)+getLocalRegionMax(indx,timestep)));
    }
    //Methods to set the region max and min from a float value.
    //public so accessible from router
    //
    int SetLocalRegionMin(int coord, double minval, int timestep);
    int SetLocalRegionMax(int coord, double maxval, int timestep);

    
    const vector<long> GetTimes(){ return GetBox()->GetValueLongVec(Box::_timesTag);}
    
    bool extentsAreVarying(){ return GetBox()->GetTimes().size()>1;}

    bool insertTime(int timestep);

    bool removeTime(int timestep);

    const vector<double> GetAllExtents(){ return GetBox()->GetValueDoubleVec(Box::_extentsTag);}

    static const vector<string> GetDomainVariables(){ 
        vector<string>vec;
        ((RegionParams*)Params::GetParamsInstance(_regionParamsTag,-1,-1))->GetValueStringVec(_domainVariablesTag, vec);
        return vec;
    }
    static int SetDomainVariables(vector<string> varnames){ 
        if (varnames.size() == 0) return -1;
        return ((RegionParams*)Params::GetParamsInstance(_regionParamsTag,-1,-1))->SetValueStringVec(_domainVariablesTag, "Set Domain-defining variables",varnames);
    }
#ifndef DOXYGEN_SKIP_THIS
private:
    static const string _shortName;
    static const string _domainVariablesTag;
    void clearRegionsMap();
    
#endif //DOXYGEN_SKIP_THIS
};

};
#endif //REGIONPARAMS_H