VAPOR3 3.9.4
Public Member Functions | Public Attributes | List of all members
VAPoR::FakeRakeBox Class Reference

#include <FlowParams.h>

Inheritance diagram for VAPoR::FakeRakeBox:
VAPoR::Box VAPoR::ParamsBase Wasp::MyBase

Public Member Functions

void Initialize (string tag)
 
void SetExtents (const vector< double > &minExt, const vector< double > &maxExt) override
 
 Box (ParamsBase::StateSave *ssave, string name=Box::GetClassType())
 Create a Box object from scratch.
 
 Box (ParamsBase::StateSave *ssave, XmlNode *node)
 Create a Box object from an existing XmlNode tree.
 
- Public Member Functions inherited from VAPoR::Box
 Box (ParamsBase::StateSave *ssave, string name=Box::GetClassType())
 Create a Box object from scratch.
 
 Box (ParamsBase::StateSave *ssave, XmlNode *node)
 Create a Box object from an existing XmlNode tree.
 
virtual ~Box ()
 
virtual void SetExtents (const vector< double > &minExt, const vector< double > &maxExt)
 
virtual void SetExtents (const VAPoR::CoordType &minExt, const VAPoR::CoordType &maxExt)
 
void GetExtents (vector< double > &minExt, vector< double > &maxExt) const
 
void GetExtents (VAPoR::CoordType &minExt, VAPoR::CoordType &maxExt) const
 
bool IsPlanar () const
 
void SetPlanar (bool value)
 
int GetOrientation () const
 
void SetOrientation (long value)
 
vector< double > GetAngles () const
 
void SetAngles (const double angles[3])
 
void SetAngles (const float angles[3])
 
void SetAngles (const vector< double > &vals)
 
- Public Member Functions inherited from VAPoR::ParamsBase
 ParamsBase (StateSave *ssave, const string &classname)
 
 ParamsBase (StateSave *ssave, XmlNode *node)
 
 ParamsBase (const ParamsBase &rhs)
 Copy constructor.
 
ParamsBaseoperator= (const ParamsBase &rhs)
 
 ParamsBase (ParamsBase &&)=delete
 
ParamsBaseoperator= (ParamsBase &)=delete
 
bool operator== (const ParamsBase &rhs) const
 Equivalence operator.
 
bool operator!= (const ParamsBase &rhs) const
 
virtual ~ParamsBase ()
 
void SetParent (ParamsBase *parent)
 
XmlNodeGetNode () const
 
void BeginGroup (const string &description)
 
void EndGroup ()
 
void IntermediateChange ()
 
virtual vector< long > GetValueLongVec (const string tag) const
 
virtual vector< long > GetValueLongVec (const string tag, const vector< long > &defaultVal) const
 
virtual long GetValueLong (const string tag, long defaultVal) const
 
virtual vector< double > GetValueDoubleVec (const string tag) const
 
virtual vector< double > GetValueDoubleVec (const string tag, const vector< double > &defaultVal) const
 
virtual double GetValueDouble (const string tag, double defaultVal) const
 
virtual vector< string > GetValueStringVec (const string tag) const
 
virtual vector< string > GetValueStringVec (const string tag, const vector< string > &defaultVal) const
 
virtual string GetValueString (const string tag, string defaultVal) const
 
virtual void SetValueLongVec (const string &tag, string description, const vector< long > &values)
 
virtual void SetValueLong (const string &tag, string description, long value)
 
virtual void SetValueDoubleVec (const string &tag, string description, const vector< double > &values)
 
virtual void SetValueDouble (const string &tag, string description, double value)
 
virtual void SetValueStringVec (const string &tag, string description, const vector< string > &values)
 
virtual void SetValueString (const string &tag, string description, const string &value)
 
string GetName () const
 
- Public Member Functions inherited from Wasp::MyBase
 MyBase ()
 
const string & getClassName () const
 

Public Attributes

FlowParamsparent = nullptr
 

Additional Inherited Members

- Public Types inherited from VAPoR::Box
enum  Orientation { XY = 0 , XZ = 1 , YZ = 2 , XYZ = 3 }
 
- Public Types inherited from Wasp::MyBase
typedef void(* ErrMsgCB_T) (const char *msg, int err_code)
 
typedef void(* DiagMsgCB_T) (const char *msg)
 
- Static Public Member Functions inherited from VAPoR::Box
static string GetClassType ()
 
- Static Public Member Functions inherited from Wasp::MyBase
static void SetErrMsg (const char *format,...)
 Record a formatted error message.
 
static void SetErrMsg (int errcode, const char *format,...)
 Record a formatted error message and an error code.
 
static const char * GetErrMsg ()
 
static void SetErrCode (int err_code)
 Record an error code.
 
static int GetErrCode ()
 Retrieve the current error code.
 
static void SetErrMsgCB (ErrMsgCB_T cb)
 
static ErrMsgCB_T GetErrMsgCB ()
 
static void SetErrMsgFilePtr (FILE *fp)
 
static const FILE * SetErrMsgFilePtr ()
 
static void SetDiagMsg (const char *format,...)
 Record a formatted diagnostic message.
 
static const char * GetDiagMsg ()
 
static void SetDiagMsgCB (DiagMsgCB_T cb)
 
static DiagMsgCB_T GetDiagMsgCB ()
 
static void SetDiagMsgFilePtr (FILE *fp)
 
static bool EnableErrMsg (bool enable)
 
static bool GetEnableErrMsg ()
 
- Static Public Attributes inherited from VAPoR::Box
static const string m_anglesTag
 
static const string m_extentsTag
 
static const string m_planarTag
 
static const string m_orientationTag
 
- Static Public Attributes inherited from Wasp::MyBase
static char * ErrMsg
 
static int ErrCode
 
static int ErrMsgSize
 
static FILE * ErrMsgFilePtr
 
static ErrMsgCB_T ErrMsgCB
 
static char * DiagMsg
 
static int DiagMsgSize
 
static FILE * DiagMsgFilePtr
 
static DiagMsgCB_T DiagMsgCB
 
static bool Enabled
 
- Protected Member Functions inherited from VAPoR::ParamsBase
 ParamsBase (StateSave *ssave)
 
void Remove (const string &name)
 
const map< string, string > & GetAttributes ()
 
void Clear ()
 
- Protected Member Functions inherited from Wasp::MyBase
void SetClassName (const string &name)
 
- Protected Attributes inherited from VAPoR::ParamsBase
StateSave_ssave
 
XmlNode_node
 

Detailed Description

Definition at line 19 of file FlowParams.h.

Member Function Documentation

◆ Box() [1/2]

VAPoR::Box::Box ( ParamsBase::StateSave ssave,
string  name = Box::GetClassType() 
)

Create a Box object from scratch.

◆ Box() [2/2]

VAPoR::Box::Box ( ParamsBase::StateSave ssave,
XmlNode node 
)

Create a Box object from an existing XmlNode tree.

◆ Initialize()

void VAPoR::FakeRakeBox::Initialize ( string  tag)

◆ SetExtents()

void VAPoR::FakeRakeBox::SetExtents ( const vector< double > &  minExt,
const vector< double > &  maxExt 
)
overridevirtual

Set the box min and max extents

Set the extents of the box.

Parameters
[in]minExt2 or 3-element vector containing the minimum coordinates of the box, specified in the order X, Y, Z
[in]maxExt2 or 3-element vector containing the maximum coordinates of the box, specified in the order X, Y, Z

Reimplemented from VAPoR::Box.

Member Data Documentation

◆ parent

FlowParams* VAPoR::FakeRakeBox::parent = nullptr

Definition at line 24 of file FlowParams.h.


The documentation for this class was generated from the following file: