UFO
ufo::PrimitiveVariable Class Reference

#include <PrimitiveVariables.h>

Collaboration diagram for ufo::PrimitiveVariable:

Public Member Functions

 PrimitiveVariable (const Variable &variable, size_t channelIndex, const std::vector< float > &values)
 
std::string name () const
 Return the name of the primitive variable. More...
 
const std::string & group () const
 Return the group of the primitive variable. More...
 
Variable variable () const
 Return a Variable object representing the primitive variable. More...
 
const std::vector< float > & values () const
 Return the values of the primitive variable at all observation locations. More...
 

Private Attributes

const Variablevariable_
 
size_t channelIndex_
 
const std::vector< float > & values_
 

Detailed Description

A proxy object providing access to the name, group and values of a "primitive", i.e. single-channel, variable pointed to by a PrimitiveVariablesIterator.

See also
PrimitiveVariables for an example of its use.
Warning
Never use a PrimitiveVariable object obtained by dereferencing a PrimitiveVariablesIterator after incrementing this iterator or when the iterator has gone out of scope.

Definition at line 37 of file src/ufo/utils/PrimitiveVariables.h.

Constructor & Destructor Documentation

◆ PrimitiveVariable()

ufo::PrimitiveVariable::PrimitiveVariable ( const Variable variable,
size_t  channelIndex,
const std::vector< float > &  values 
)
inline

Definition at line 39 of file src/ufo/utils/PrimitiveVariables.h.

Member Function Documentation

◆ group()

const std::string& ufo::PrimitiveVariable::group ( ) const
inline

Return the group of the primitive variable.

Definition at line 47 of file src/ufo/utils/PrimitiveVariables.h.

Here is the call graph for this function:

◆ name()

std::string ufo::PrimitiveVariable::name ( ) const
inline

Return the name of the primitive variable.

Definition at line 45 of file src/ufo/utils/PrimitiveVariables.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ values()

const std::vector<float>& ufo::PrimitiveVariable::values ( ) const
inline

Return the values of the primitive variable at all observation locations.

Definition at line 51 of file src/ufo/utils/PrimitiveVariables.h.

◆ variable()

Variable ufo::PrimitiveVariable::variable ( ) const
inline

Return a Variable object representing the primitive variable.

Definition at line 49 of file src/ufo/utils/PrimitiveVariables.h.

Member Data Documentation

◆ channelIndex_

size_t ufo::PrimitiveVariable::channelIndex_
private

Definition at line 55 of file src/ufo/utils/PrimitiveVariables.h.

◆ values_

const std::vector<float>& ufo::PrimitiveVariable::values_
private

Definition at line 56 of file src/ufo/utils/PrimitiveVariables.h.

◆ variable_

const Variable& ufo::PrimitiveVariable::variable_
private

Definition at line 54 of file src/ufo/utils/PrimitiveVariables.h.


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