libdap Updated for version 3.21.1
libdap4 is an implementation of OPeNDAP's DAP protocol.
libdap::D4Dimensions Class Reference

#include <D4Dimensions.h>

Collaboration diagram for libdap::D4Dimensions:
Collaboration graph

Public Types

typedef vector< D4Dimension * >::const_iterator D4DimensionsCIter
 
typedef vector< D4Dimension * >::iterator D4DimensionsIter
 Iterator used for D4Dimensions.
 

Public Member Functions

void add_dim (D4Dimension *dim)
 
void add_dim_nocopy (D4Dimension *dim)
 
 D4Dimensions ()
 
 D4Dimensions (const D4Dimensions &rhs)
 
 D4Dimensions (D4Group *g)
 
D4DimensionsIter dim_begin ()
 Get an iterator to the start of the dimensions.
 
D4DimensionsIter dim_end ()
 Get an iterator to the end of the dimensions.
 
bool empty () const
 Does this D4Dimensions object actually have dimensions?
 
D4Dimensionfind_dim (const string &name)
 
void insert_dim (D4Dimension *dim, D4DimensionsIter i)
 
void insert_dim_nocopy (D4Dimension *dim, D4DimensionsIter i)
 
D4Dimensionsoperator= (const D4Dimensions &rhs)
 
D4Groupparent () const
 
void print_dap4 (XMLWriter &xml, bool constrained=false) const
 
void set_parent (D4Group *g)
 
virtual ~D4Dimensions ()
 

Protected Member Functions

void m_duplicate (const D4Dimensions &rhs)
 

Detailed Description

This class holds information about dimensions. This can be used to store actual dimension information in an instance of BaseType and it can be used to store the definition of a dimension in an instance of Group.

Definition at line 103 of file D4Dimensions.h.

Member Typedef Documentation

◆ D4DimensionsCIter

Definition at line 125 of file D4Dimensions.h.

◆ D4DimensionsIter

Iterator used for D4Dimensions.

Definition at line 124 of file D4Dimensions.h.

Constructor & Destructor Documentation

◆ D4Dimensions() [1/3]

libdap::D4Dimensions::D4Dimensions ( )
inline

Definition at line 127 of file D4Dimensions.h.

◆ D4Dimensions() [2/3]

libdap::D4Dimensions::D4Dimensions ( D4Group * g)
inline

Definition at line 128 of file D4Dimensions.h.

◆ D4Dimensions() [3/3]

libdap::D4Dimensions::D4Dimensions ( const D4Dimensions & rhs)
inline

Definition at line 129 of file D4Dimensions.h.

◆ ~D4Dimensions()

virtual libdap::D4Dimensions::~D4Dimensions ( )
inlinevirtual

Definition at line 131 of file D4Dimensions.h.

Member Function Documentation

◆ add_dim()

void libdap::D4Dimensions::add_dim ( D4Dimension * dim)
inline

Append a new dimension. In DAP4 dimensions are either of a known size or are varying. For fixed-size dimensions, the value of varying should be false. For varying dimensions the value of 'size' will be ignored - any value can be used when called this method.

Parameters
dimPointer to the D4Dimension object to add; deep copy

Definition at line 158 of file D4Dimensions.h.

◆ add_dim_nocopy()

void libdap::D4Dimensions::add_dim_nocopy ( D4Dimension * dim)
inline

Append a new dimension.

Parameters
dimPointer to the D4Dimension object to add; copies the pointer

Definition at line 163 of file D4Dimensions.h.

◆ dim_begin()

D4DimensionsIter libdap::D4Dimensions::dim_begin ( )
inline

Get an iterator to the start of the dimensions.

Definition at line 169 of file D4Dimensions.h.

◆ dim_end()

D4DimensionsIter libdap::D4Dimensions::dim_end ( )
inline

Get an iterator to the end of the dimensions.

Definition at line 172 of file D4Dimensions.h.

◆ empty()

bool libdap::D4Dimensions::empty ( ) const
inline

Does this D4Dimensions object actually have dimensions?

Definition at line 145 of file D4Dimensions.h.

◆ find_dim()

D4Dimension * libdap::D4Dimensions::find_dim ( const string & name)

Definition at line 112 of file D4Dimensions.cc.

◆ insert_dim()

void libdap::D4Dimensions::insert_dim ( D4Dimension * dim,
D4DimensionsIter i )
inline

Insert a dimension. Insert a dimension before the position specified by the iterator.

Note
Calling this method invalidates all iterators that reference this D4Dimension object.
Parameters
dimInserted before i; deep copy
iiterator

Definition at line 183 of file D4Dimensions.h.

◆ insert_dim_nocopy()

void libdap::D4Dimensions::insert_dim_nocopy ( D4Dimension * dim,
D4DimensionsIter i )
inline

Insert a dimension.

Parameters
dimInserted before i; pointer copy
iiterator

Definition at line 189 of file D4Dimensions.h.

◆ m_duplicate()

void libdap::D4Dimensions::m_duplicate ( const D4Dimensions & rhs)
inlineprotected

Definition at line 112 of file D4Dimensions.h.

◆ operator=()

D4Dimensions & libdap::D4Dimensions::operator= ( const D4Dimensions & rhs)
inline

Definition at line 137 of file D4Dimensions.h.

◆ parent()

D4Group * libdap::D4Dimensions::parent ( ) const
inline

Definition at line 147 of file D4Dimensions.h.

◆ print_dap4()

void libdap::D4Dimensions::print_dap4 ( XMLWriter & xml,
bool constrained = false ) const

Definition at line 120 of file D4Dimensions.cc.

◆ set_parent()

void libdap::D4Dimensions::set_parent ( D4Group * g)
inline

Definition at line 148 of file D4Dimensions.h.


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