VAPOR3 3.9.4
Public Types | Public Member Functions | List of all members
VAPoR::BOVCollection Class Reference

#include <BOVCollection.h>

Inheritance diagram for VAPoR::BOVCollection:
Wasp::MyBase

Public Types

enum class  parseCodes { PARSE_ERROR = -1 , NOT_FOUND = 0 , FOUND = 1 }
 
- Public Types inherited from Wasp::MyBase
typedef void(* ErrMsgCB_T) (const char *msg, int err_code)
 
typedef void(* DiagMsgCB_T) (const char *msg)
 

Public Member Functions

 BOVCollection ()
 
int Initialize (const std::vector< std::string > &paths)
 
std::vector< std::string > GetDataVariableNames () const
 
std::string GetTimeDimension () const
 
std::vector< float > GetUserTimes () const
 
float GetUserTime (size_t ts) const
 
std::array< size_t, 3 > GetDataSize () const
 
std::array< std::string, 3 > GetSpatialDimensions () const
 
DC::XType GetDataFormat () const
 
std::array< double, 3 > GetBrickOrigin () const
 
std::array< double, 3 > GetBrickSize () const
 
template<class T >
int ReadRegion (std::string varname, size_t ts, const std::vector< size_t > &min, const std::vector< size_t > &max, T region)
 
- Public Member Functions inherited from Wasp::MyBase
 MyBase ()
 
const string & getClassName () const
 

Additional Inherited Members

- 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 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 Wasp::MyBase
void SetClassName (const string &name)
 

Detailed Description

Definition at line 11 of file BOVCollection.h.

Member Enumeration Documentation

◆ parseCodes

Enumerator
PARSE_ERROR 
NOT_FOUND 
FOUND 

Definition at line 13 of file BOVCollection.h.

Constructor & Destructor Documentation

◆ BOVCollection()

VAPoR::BOVCollection::BOVCollection ( )

Member Function Documentation

◆ GetBrickOrigin()

std::array< double, 3 > VAPoR::BOVCollection::GetBrickOrigin ( ) const

◆ GetBrickSize()

std::array< double, 3 > VAPoR::BOVCollection::GetBrickSize ( ) const

◆ GetDataFormat()

DC::XType VAPoR::BOVCollection::GetDataFormat ( ) const

◆ GetDataSize()

std::array< size_t, 3 > VAPoR::BOVCollection::GetDataSize ( ) const

◆ GetDataVariableNames()

std::vector< std::string > VAPoR::BOVCollection::GetDataVariableNames ( ) const

◆ GetSpatialDimensions()

std::array< std::string, 3 > VAPoR::BOVCollection::GetSpatialDimensions ( ) const

◆ GetTimeDimension()

std::string VAPoR::BOVCollection::GetTimeDimension ( ) const

◆ GetUserTime()

float VAPoR::BOVCollection::GetUserTime ( size_t  ts) const
inline

Definition at line 21 of file BOVCollection.h.

References GetUserTimes().

◆ GetUserTimes()

std::vector< float > VAPoR::BOVCollection::GetUserTimes ( ) const

Referenced by GetUserTime().

◆ Initialize()

int VAPoR::BOVCollection::Initialize ( const std::vector< std::string > &  paths)

◆ ReadRegion()

template<class T >
int VAPoR::BOVCollection::ReadRegion ( std::string  varname,
size_t  ts,
const std::vector< size_t > &  min,
const std::vector< size_t > &  max,
region 
)

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