ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
FrameCPP::Version_8::Dimension Class Reference

Dimension information for a Vect. More...

#include <Dimension.hh>

Public Types

typedef DIMENSION_NDIM_TYPE nDim_type
 
typedef DIMENSION_NX_TYPE nx_type
 
typedef DIMENSION_DX_TYPE dx_type
 
typedef DIMENSION_STARTX_TYPE startX_type
 
typedef STRING unitX_type
 

Public Member Functions

 Dimension ()
 exc: None. More...
 
 Dimension (const Dimension &dim)
 param: const Dimension& dim - The Dimension to copy from. More...
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0)
 Constructor. More...
 
 Dimension (const Previous::Dimension &Source)
 
const Dimensionoperator= (const Dimension &dim)
 Assignment operator. More...
 
bool operator== (const Dimension &dim) const
 Equal comparison. More...
 
bool operator!= (const Dimension &dim) const
 Not equal comparison. More...
 
nx_type GetNx () const
 Get the dimension length. More...
 
dx_type GetDx () const
 Get the scale factor. More...
 
startX_type GetStartX () const
 Get data set origin. More...
 
const unitX_typeGetUnitX () const
 Get the units. More...
 
void SetDx (dx_type Dx)
 Set sample spacing. More...
 
void SetNx (nx_type Nx)
 Set dimension length. More...
 
void SetStartX (startX_type StartX)
 Set data set origin. More...
 
void SetUnitX (const unitX_type &UnitX)
 Set scale factor in ASCII. More...
 
cmn_streamsize_type Bytes () const
 

Static Public Member Functions

static nx_type CalcNData (nDim_type NDims, const Dimension *Dims)
 

Detailed Description

Dimension information for a Vect.

This is a simple class storing dimension information for a Vect object. It stores the following:

  1. The dimension length.
  2. Scale factor
  3. The units (unit per step size along the coordintate).

Member Typedef Documentation

Constructor & Destructor Documentation

FrameCPP::Version_8::Dimension::Dimension ( )

exc: None.

FrameCPP::Version_8::Dimension::Dimension ( const Dimension dim)

param: const Dimension& dim - The Dimension to copy from.

exc: std::bad_alloc - Memory allocation failed.

FrameCPP::Version_8::Dimension::Dimension ( nx_type  nx,
dx_type  dx = 1.0,
const std::string &  unitX = "",
startX_type  startx = 0.0 
)
explicit

Constructor.

This creates a Dimension object with the specified attributes.

Parameters
[in]nxThe dimension length.
[in]dxThe Scale Factor.
[in]unitXThe units (unit per step size).
[in]startxThe origin of the data set.
Exceptions
std::bad_allocMemory allocation failed.
FrameCPP::Version_8::Dimension::Dimension ( const Previous::Dimension &  Source)
inline

Member Function Documentation

cmn_streamsize_type FrameCPP::Version_8::Dimension::Bytes ( ) const
inline
Dimension::nx_type FrameCPP::Version_8::Dimension::CalcNData ( nDim_type  NDims,
const Dimension Dims 
)
inlinestatic
Dimension::dx_type FrameCPP::Version_8::Dimension::GetDx ( ) const
inline

Get the scale factor.

Returns
The scale factor.
Dimension::nx_type FrameCPP::Version_8::Dimension::GetNx ( ) const
inline

Get the dimension length.

Returns
The dimension length.
Dimension::startX_type FrameCPP::Version_8::Dimension::GetStartX ( ) const
inline

Get data set origin.

Returns
Data set origin.
const Dimension::unitX_type & FrameCPP::Version_8::Dimension::GetUnitX ( ) const
inline

Get the units.

Returns
The units.
bool FrameCPP::Version_8::Dimension::operator!= ( const Dimension dim) const
inline

Not equal comparison.

Parameters
[in]dimThe object to compare with.
Returns
false if the objects are equal, true otherwise.
const Dimension & FrameCPP::Version_8::Dimension::operator= ( const Dimension dim)
inline

Assignment operator.

Parameters
[in]dimThe object to assign from.
Returns
This object.
bool FrameCPP::Version_8::Dimension::operator== ( const Dimension dim) const
inline

Equal comparison.

Parameters
[in]dimThe object to compare with.
Returns
true if the objects are equal, false otherwise.
void FrameCPP::Version_8::Dimension::SetDx ( dx_type  Dx)
inline

Set sample spacing.

Establish a new value for sample spacing along the coordinate.

Parameters
[in]DxThe new sample rate for the coordinate.
void FrameCPP::Version_8::Dimension::SetNx ( nx_type  Nx)
inline

Set dimension length.

Parameters
[in]NxThe new dimension length
void FrameCPP::Version_8::Dimension::SetStartX ( startX_type  StartX)
inline

Set data set origin.

Parameters
[in]StartXData set origin.
void FrameCPP::Version_8::Dimension::SetUnitX ( const unitX_type UnitX)
inline

Set scale factor in ASCII.

Establish a new value for sample spacing along the coordinate.

Parameters
[in]UnitXThe new scale factor description.

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