VAPoR::DC::Dimension Class Reference

Metadata describing a named dimension length. More...

#include <DC.h>

Public Member Functions
	Dimension ()
	Dimension (std::string name, std::vector< size_t > lengths)
	Dimension (std::string name, size_t length)
virtual	~Dimension ()
string	GetName () const
	Get dimension name.
size_t	GetLength () const
size_t	GetLength (size_t index) const
bool	IsTimeVarying () const

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

Detailed Description

Metadata describing a named dimension length.

Describes an array dimension with a name and an associated length. Dimension lengths may vary (e.g. over time).

Definition at line 163 of file DC.h.

Constructor & Destructor Documentation

Dimension() [1/3]

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

inline

Definition at line 165 of file DC.h.

Dimension() [2/3]

VAPoR::DC::Dimension::Dimension ( std::string  name, std::vector< size_t >  lengths  )

inline

Dimension class constructor for multi-length dimension

Parameters

[in]	name	The name of dimension
[in]	lengths	A vector of dimension lengths.

Definition at line 176 of file DC.h.

Dimension() [3/3]

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

inline

Dimension class constructor for constant-length dimension

Parameters

[in]	name	The name of dimension
[in]	length	The dimension length.

Definition at line 187 of file DC.h.

~Dimension()

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

inlinevirtual

Definition at line 194 of file DC.h.

Member Function Documentation

GetLength() [1/2]

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

inline

Return dimension length

For a multi-length dimension the first length is returned

Definition at line 204 of file DC.h.

Referenced by VAPoR::DataMgr::GetDimensionLength().

GetLength() [2/2]

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

inline

Return a dimension length

Parameters

[in]

index

Return the length of the dimension for the indicated element. If index is out of range the value 0 is returned

Definition at line 211 of file DC.h.

GetName()

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

inline

Get dimension name.

Definition at line 198 of file DC.h.

IsTimeVarying()

bool VAPoR::DC::Dimension::IsTimeVarying ( ) const

inline

Return boolean indicating whether dimension can vary over time

This method returns true if the dimesion length can vary over time.

Definition at line 217 of file DC.h.

Friends And Related Function Documentation

operator<<

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

friend

---

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

• /Users/pearse/VAPOR/include/vapor/DC.h