Box.h

Go to the documentation of this file.

//************************************************************************
//                                                                  *
//           Copyright (C)  2011                                    *
//     University Corporation for Atmospheric Research              *
//           All Rights Reserved                                    *
//                                                                  *
//************************************************************************/
//
//  File:       Box.h
//
//  Author:     Alan Norton
//          National Center for Atmospheric Research
//          PO 3000, Boulder, Colorado
//
//  Date:       April 2011
//
//  Description:    Defines the Box class
//      This supports control of a 2D or 3D box-shaped region that can be
//      rotated and changed over time.
//
#ifndef BOX_H
#define BOX_H

namespace VAPoR {
#include <vapor/ParamsBase.h>

class PARAMS_API Box : public ParamsBase {
public:
    
    Box();
    static ParamsBase* CreateDefaultInstance() {return new Box();}
    
    int GetUserExtents(double extents[6], size_t timestep);
    int GetUserExtents(float extents[6], size_t timestep);

    int GetLocalExtents(double extents[6], int timestep = -1);
    int GetLocalExtents(float extents[6], int timestep = -1);
    const vector<double>&  GetLocalExtents() {
        const vector<double> localExtents(6,0.);
        return GetRootNode()->GetElementDouble(_extentsTag,localExtents);
    }
    int SetLocalExtents(const vector<double>& extents, int timestep = -1);
    int SetLocalExtents(const double extents[6], int timestep = -1);
    int SetLocalExtents(const float extents[6], int timestep = -1);
    
    const vector<double>& GetAngles(){
        const vector<double> defaultAngles(3,0.);
        return GetRootNode()->GetElementDouble(Box::_anglesTag,defaultAngles);
    }
    int GetAngles(double ang[3]){
        const vector<double> defaultAngles(3,0.);
        const vector<double>& angles = GetRootNode()->GetElementDouble(Box::_anglesTag,defaultAngles);
        if (angles.size() != 3) return -1;
        for (int i = 0; i<3;i++) ang[i]=angles[i];
        return 0;
    }
    int GetAngles(float ang[3]){
        const vector<double> defaultAngles(3,0.);
        const vector<double>& angles = GetRootNode()->GetElementDouble(Box::_anglesTag,defaultAngles);
        if (angles.size() != 3) return -1;
        for (int i = 0; i<3;i++) ang[i]=(float)angles[i];
        return 0;
    }
    int SetAngles(const double angles[3]){
        vector<double> ang;
        for (int i = 0; i<3;i++) ang.push_back(angles[i]);
        return GetRootNode()->SetElementDouble(_anglesTag, ang);
    }
    int SetAngles(const float angles[3]){
        vector<double> angl;
        for (int i = 0; i<3;i++) angl.push_back((double)angles[i]);
        return GetRootNode()->SetElementDouble(_anglesTag, angl);
    }
    void SetAngles(const vector<double>& vals){
        GetRootNode()->SetElementDouble(_anglesTag, vals);
    }
    const vector<long>& GetTimes() { 
        const vector<long> defaultTimes(1,0);
        return( GetRootNode()->GetElementLong(Box::_timesTag,defaultTimes));
    }
    void SetTimes(const vector<long>& times) { GetRootNode()->SetElementLong(Box::_timesTag, times);}
    void Trim(int numTimes = 1){
        if (numTimes > GetTimes().size()) return;
        vector<long> times = GetTimes();
        times.resize(numTimes);
        GetRootNode()->SetElementLong(Box::_timesTag,times);
        vector<double> exts; 
        vector<double>defaultExts(6,0.);
        exts = GetRootNode()->GetElementDouble(Box::_extentsTag,defaultExts);
        GetRootNode()->SetElementDouble(Box::_extentsTag, exts);
    }
    static const string _boxTag;
    static const string _anglesTag;
    static const string _extentsTag;
    static const string _timesTag;

    
};
};
#endif