VAPoR  3.0.0
Public Member Functions | Friends | List of all members
VAPoR::DC::Dimension Class Reference

Metadata describing a coordinate dimension. More...

#include <DC.h>

Public Member Functions

 Dimension ()
 
 Dimension (std::string name, size_t length, int axis)
 
virtual ~Dimension ()
 
void Clear ()
 
string GetName () const
 Get dimension name. More...
 
void SetName (string name)
 Set dimension name. More...
 
size_t GetLength () const
 Access dimension length. More...
 
void SetLength (size_t length)
 Set dimension length. More...
 
int GetAxis () const
 Access dimension axis. More...
 
void SetAxis (int axis)
 Set dimension axis. More...
 
bool operator== (const Dimension &rhs) const
 
bool operator!= (const Dimension &rhs) const
 

Friends

std::ostream & operator<< (std::ostream &o, const Dimension &dimension)
 

Detailed Description

Metadata describing a coordinate dimension.

Definition at line 161 of file DC.h.

Constructor & Destructor Documentation

VAPoR::DC::Dimension::Dimension ( )
inline

Default dimension constructor

Definition at line 166 of file DC.h.

VAPoR::DC::Dimension::Dimension ( std::string  name,
size_t  length,
int  axis 
)
inline

Dimension class constructor

Parameters
[in]nameThe name of dimension
[in]lengthThe dimension length
[in]axisThe dimension axis, an integer in the range 0..3 indicating X (or longitude), Y (latitude), Z (height), and T (time), respectively.

Definition at line 180 of file DC.h.

virtual VAPoR::DC::Dimension::~Dimension ( )
inlinevirtual

Definition at line 185 of file DC.h.

Member Function Documentation

void VAPoR::DC::Dimension::Clear ( )
inline

Definition at line 187 of file DC.h.

int VAPoR::DC::Dimension::GetAxis ( ) const
inline

Access dimension axis.

Definition at line 211 of file DC.h.

size_t VAPoR::DC::Dimension::GetLength ( ) const
inline

Access dimension length.

Definition at line 203 of file DC.h.

string VAPoR::DC::Dimension::GetName ( ) const
inline

Get dimension name.

Definition at line 195 of file DC.h.

bool VAPoR::DC::Dimension::operator!= ( const Dimension rhs) const
inline

Definition at line 220 of file DC.h.

bool VAPoR::DC::Dimension::operator== ( const Dimension rhs) const
inline

Definition at line 217 of file DC.h.

void VAPoR::DC::Dimension::SetAxis ( int  axis)
inline

Set dimension axis.

Definition at line 215 of file DC.h.

void VAPoR::DC::Dimension::SetLength ( size_t  length)
inline

Set dimension length.

Definition at line 207 of file DC.h.

void VAPoR::DC::Dimension::SetName ( string  name)
inline

Set dimension name.

Definition at line 199 of file DC.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const Dimension dimension 
)
friend

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