VAPOR3 3.9.4
Classes | Public Member Functions | Friends | List of all members
VAPoR::DC::Attribute Class Reference

Variable or global metadata. More...

#include <DC.h>

Public Member Functions

 Attribute ()
 
 Attribute (string name, XType type, const std::vector< float > &values)
 
 Attribute (string name, XType type, const std::vector< double > &values)
 
 Attribute (string name, XType type, const std::vector< int > &values)
 
 Attribute (string name, XType type, const std::vector< long > &values)
 
 Attribute (string name, XType type, const string &values)
 
 Attribute (string name, XType type)
 
virtual ~Attribute ()
 
string GetName () const
 Get attribute name.
 
XType GetXType () const
 Get an attribute's external representation type.
 
VDF_API void GetValues (std::vector< float > &values) const
 
VDF_API void GetValues (std::vector< double > &values) const
 
VDF_API void GetValues (std::vector< int > &values) const
 
VDF_API void GetValues (std::vector< long > &values) const
 
VDF_API void GetValues (string &values) const
 
void SetValues (const std::vector< float > &values)
 
void SetValues (const std::vector< double > &values)
 
void SetValues (const std::vector< int > &values)
 
void SetValues (const std::vector< long > &values)
 
void SetValues (const string &values)
 

Friends

std::ostream & operator<< (std::ostream &o, const Attribute &attr)
 

Detailed Description

Variable or global metadata.

Definition at line 677 of file DC.h.

Constructor & Destructor Documentation

◆ Attribute() [1/7]

VAPoR::DC::Attribute::Attribute ( )
inline

Definition at line 679 of file DC.h.

◆ Attribute() [2/7]

VAPoR::DC::Attribute::Attribute ( string  name,
XType  type,
const std::vector< float > &  values 
)

Attribute constructor

Parameters
[in]nameThe name of the attribute
[in]typeExternal representation format
[in]valuesA vector specifying the attribute's values

◆ Attribute() [3/7]

VAPoR::DC::Attribute::Attribute ( string  name,
XType  type,
const std::vector< double > &  values 
)

◆ Attribute() [4/7]

VAPoR::DC::Attribute::Attribute ( string  name,
XType  type,
const std::vector< int > &  values 
)

◆ Attribute() [5/7]

VAPoR::DC::Attribute::Attribute ( string  name,
XType  type,
const std::vector< long > &  values 
)

◆ Attribute() [6/7]

VAPoR::DC::Attribute::Attribute ( string  name,
XType  type,
const string &  values 
)

◆ Attribute() [7/7]

VAPoR::DC::Attribute::Attribute ( string  name,
XType  type 
)
inline

Definition at line 697 of file DC.h.

◆ ~Attribute()

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

Definition at line 703 of file DC.h.

Member Function Documentation

◆ GetName()

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

Get attribute name.

Definition at line 707 of file DC.h.

Referenced by VAPoR::DC::BaseVar::SetAttribute().

◆ GetValues() [1/5]

VDF_API void VAPoR::DC::Attribute::GetValues ( std::vector< double > &  values) const

◆ GetValues() [2/5]

VDF_API void VAPoR::DC::Attribute::GetValues ( std::vector< float > &  values) const

Get an attribute's value(s)

Get the value(s) for an attribute, performing type conversion as necessary from the external storage type to the desired type

◆ GetValues() [3/5]

VDF_API void VAPoR::DC::Attribute::GetValues ( std::vector< int > &  values) const

◆ GetValues() [4/5]

VDF_API void VAPoR::DC::Attribute::GetValues ( std::vector< long > &  values) const

◆ GetValues() [5/5]

VDF_API void VAPoR::DC::Attribute::GetValues ( string &  values) const

◆ GetXType()

XType VAPoR::DC::Attribute::GetXType ( ) const
inline

Get an attribute's external representation type.

Definition at line 711 of file DC.h.

◆ SetValues() [1/5]

void VAPoR::DC::Attribute::SetValues ( const std::vector< double > &  values)

◆ SetValues() [2/5]

void VAPoR::DC::Attribute::SetValues ( const std::vector< float > &  values)

Set an attribute's value(s)

Set the value(s) for an attribute, performing type conversion as necessary to meet the external storage type.

◆ SetValues() [3/5]

void VAPoR::DC::Attribute::SetValues ( const std::vector< int > &  values)

◆ SetValues() [4/5]

void VAPoR::DC::Attribute::SetValues ( const std::vector< long > &  values)

◆ SetValues() [5/5]

void VAPoR::DC::Attribute::SetValues ( const string &  values)

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  o,
const Attribute attr 
)
friend

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