PlotParams.h

Go to the documentation of this file.

//************************************************************************
//                                                                       *
//           Copyright (C)  2004                                         *
//     University Corporation for Atmospheric Research                   *
//           All Rights Reserved                                         *
//                                                                       *
//************************************************************************
//
//  File:       PlotParams.h
//
//  Author:     Samuel Li
//              National Center for Atmospheric Research
//              PO 3000, Boulder, Colorado
//
//  Date:       December 2017
//
//  Description:    Defines the PlotParams class.
//
 
#ifndef PLOTPARAMS_H
#define PLOTPARAMS_H
 
#include <vapor/RenderParams.h>
 
namespace VAPoR {
 
class PlotParams : public RenderParams {
public:
    PlotParams(DataMgr *dmgr, ParamsBase::StateSave *ssave);
    PlotParams(DataMgr *dmgr, ParamsBase::StateSave *ssave, XmlNode *node);
    ~PlotParams();
 
    std::vector<long int> GetMinMaxTS() const;
    void                  SetMinMaxTS(const std::vector<long int> &);
 
    std::vector<double> GetSinglePoint() const;
    void                SetSinglePoint(const std::vector<double> &point);
 
    std::vector<double> GetPoint1() const;
    std::vector<double> GetPoint2() const;
    void                SetPoint1(const std::vector<double> &point);
    void                SetPoint2(const std::vector<double> &point);
 
    std::vector<double> GetMinExtents() const;
    std::vector<double> GetMaxExtents() const;
    void                SetMinExtents(const std::vector<double> &point);
    void                SetMaxExtents(const std::vector<double> &point);
 
    long GetNumOfSamples() const;
    void SetNumOfSamples(long);
 
    void              SetAxisLocks(const std::vector<bool> &locks);
    std::vector<bool> GetAxisLocks();
 
    static string  GetClassType() { return ("PlotParams"); }
    virtual size_t GetRenderDim() const override { return (0); }
    virtual string GetActualColorMapVariableName() const override { return ""; }
 
private:
    static const string _minMaxTSTag;
    static const string _p1Tag;            // point1 in space mode
    static const string _p2Tag;            // point2 in space mode
    static const string _numSamplesTag;    // number of samples in space mode
    static const string _singlePtTag;      // a single point in time mode
    static const string _lockAxisTag;      // if we lock x, y, or z axis
    static const string _minExtentTag;     // minimal extent we've seen so far
    static const string _maxExtentTag;     // maximal extent we've seen so far
};
 
};    // End namespace VAPoR
#endif