FONcDim Class Reference

A class that represents the dimension of an array. More...

#include <FONcDim.h>

Inheritance diagram for FONcDim:

Collaboration diagram for FONcDim:

Public Member Functions
virtual void	decref ()
	Decrement the reference count for this dimension.
virtual void	define (int ncid)
	define the DAP dimension in the netcdf file
virtual void	define_struct (int ncid)
virtual bool	defined ()
virtual int	dimid ()
virtual void	dump (std::ostream &strm) const
	dumps information about this object for debugging purposes
	FONcDim (const std::string &name, int64_t size)
	Constructor for FOncDim that defines the dimension of an array.
virtual void	incref ()
virtual std::string	name ()
virtual int64_t	size ()
virtual void	struct_decref ()
virtual void	struct_incref ()
virtual void	update_size (int64_t newsize)

Static Public Attributes
static int	DimNameNum = 0
static int	StructDimNameNum = 0

Detailed Description

A class that represents the dimension of an array.

This class represents a dimension of a DAP Array with additional information needed to write it out to a netcdf file. Since this dimension can be shared, it includes reference counting so that it can be pointed to by multiple arrays.

Definition at line 44 of file FONcDim.h.

Constructor & Destructor Documentation

FONcDim()

FONcDim::FONcDim	(	const std::string &	name,
		int64_t	size )

Constructor for FOncDim that defines the dimension of an array.

Parameters

name	The name of the dimension
size	The size of the dimension

Definition at line 50 of file FONcDim.cc.

~FONcDim()

virtual FONcDim::~FONcDim ( )

inlinevirtual

Definition at line 55 of file FONcDim.h.

Member Function Documentation

decref()

void FONcDim::decref ( )

virtual

Decrement the reference count for this dimension.

Since dimensions can be shared, there might be more than one array pointing to it. For this reason, we use reference counting for the instance. if the reference count gets to zero, then the instance is deleted

Definition at line 62 of file FONcDim.cc.

define()

void FONcDim::define ( int ncid )

virtual

define the DAP dimension in the netcdf file

If the dimension has not already been created by an array that shares this dimension, then define the dimension in the netcdf file.

If the dimension name is empty, the create a default one using an incremented counter.

Parameters

ncid	The id of the NetCDF file

Exceptions

BESInternalError

if there is a problem defining the dimension

Definition at line 85 of file FONcDim.cc.

define_struct()

void FONcDim::define_struct ( int ncid )

virtual

Definition at line 109 of file FONcDim.cc.

defined()

virtual bool FONcDim::defined ( )

inlinevirtual

Definition at line 68 of file FONcDim.h.

dimid()

virtual int FONcDim::dimid ( )

inlinevirtual

Definition at line 67 of file FONcDim.h.

dump()

void FONcDim::dump ( std::ostream & strm ) const

virtual

dumps information about this object for debugging purposes

Displays the pointer value of this instance plus instance data

Parameters

strm	C++ i/o stream to dump the information to

Implements BESObj.

Definition at line 137 of file FONcDim.cc.

incref()

virtual void FONcDim::incref ( )

inlinevirtual

Definition at line 56 of file FONcDim.h.

name()

virtual std::string FONcDim::name ( )

inlinevirtual

Definition at line 64 of file FONcDim.h.

size()

virtual int64_t FONcDim::size ( )

inlinevirtual

Definition at line 65 of file FONcDim.h.

struct_decref()

void FONcDim::struct_decref ( )

virtual

Definition at line 68 of file FONcDim.cc.

struct_incref()

virtual void FONcDim::struct_incref ( )

inlinevirtual

Definition at line 58 of file FONcDim.h.

update_size()

virtual void FONcDim::update_size ( int64_t newsize )

inlinevirtual

Definition at line 66 of file FONcDim.h.

Member Data Documentation

DimNameNum

int FONcDim::DimNameNum = 0

static

Definition at line 72 of file FONcDim.h.

StructDimNameNum

int FONcDim::StructDimNameNum = 0

static

Definition at line 73 of file FONcDim.h.

---

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

• FONcDim.h
• FONcDim.cc