ldas-tools-framecpp  2.9.3
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::Dimension Class Reference

Dimension information for a Vect. More...

#include <Dimension.hh>

Collaboration diagram for FrameCPP::Version_8::Dimension:
Collaboration graph
[legend]

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
 
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
 
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 ()
 Default Constructor. More...
 
 Dimension (const Dimension &dim)
 Copy constructor. 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
 
 Dimension ()
 
 Dimension (const Dimension &dim)
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0)
 
 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
 
 Dimension ()
 
 Dimension (const Dimension &dim)
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0)
 
 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)
 
static nx_type CalcNData (nDim_type NDims, const Dimension *Dims)
 
static nx_type CalcNData (nDim_type NDims, const Dimension *Dims)
 

Private Attributes

nx_type mNx
 Dimension length. More...
 
dx_type mDx
 Scale factor. More...
 
unitX_type mUnitX
 Scale factor in ASCII. More...
 
startX_type mStartX
 Origin. More...
 

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

◆ dx_type [1/3]

typedef DIMENSION_DX_TYPE FrameCPP::Version_8::Dimension::dx_type

◆ dx_type [2/3]

typedef DIMENSION_DX_TYPE FrameCPP::Version_8::Dimension::dx_type

◆ dx_type [3/3]

typedef DIMENSION_DX_TYPE FrameCPP::Version_8::Dimension::dx_type

◆ nDim_type [1/3]

typedef DIMENSION_NDIM_TYPE FrameCPP::Version_8::Dimension::nDim_type

◆ nDim_type [2/3]

typedef DIMENSION_NDIM_TYPE FrameCPP::Version_8::Dimension::nDim_type

◆ nDim_type [3/3]

typedef DIMENSION_NDIM_TYPE FrameCPP::Version_8::Dimension::nDim_type

◆ nx_type [1/3]

typedef DIMENSION_NX_TYPE FrameCPP::Version_8::Dimension::nx_type

◆ nx_type [2/3]

typedef DIMENSION_NX_TYPE FrameCPP::Version_8::Dimension::nx_type

◆ nx_type [3/3]

typedef DIMENSION_NX_TYPE FrameCPP::Version_8::Dimension::nx_type

◆ startX_type [1/3]

typedef DIMENSION_STARTX_TYPE FrameCPP::Version_8::Dimension::startX_type

◆ startX_type [2/3]

typedef DIMENSION_STARTX_TYPE FrameCPP::Version_8::Dimension::startX_type

◆ startX_type [3/3]

typedef DIMENSION_STARTX_TYPE FrameCPP::Version_8::Dimension::startX_type

◆ unitX_type [1/3]

typedef STRING FrameCPP::Version_8::Dimension::unitX_type

◆ unitX_type [2/3]

typedef STRING FrameCPP::Version_8::Dimension::unitX_type

◆ unitX_type [3/3]

typedef STRING FrameCPP::Version_8::Dimension::unitX_type

Constructor & Destructor Documentation

◆ Dimension() [1/12]

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

Default Constructor.

This creates a dimension object with the following values:

Dimension Length (Nx) - 1 Scale Factor (Dx) - 1.0 Units (UnitX) - ""

◆ Dimension() [2/12]

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

Copy constructor.

Parameters
[in]dimThe Dimension to copy from.
Exceptions
std::bad_allocMemory allocation failed.

◆ Dimension() [3/12]

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.

◆ Dimension() [4/12]

FrameCPP::Version_8::Dimension::Dimension ( const Previous::Dimension Source)
inline

◆ Dimension() [5/12]

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

◆ Dimension() [6/12]

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

◆ Dimension() [7/12]

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

◆ Dimension() [8/12]

FrameCPP::Version_8::Dimension::Dimension ( const Previous::Dimension Source)

◆ Dimension() [9/12]

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

◆ Dimension() [10/12]

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

◆ Dimension() [11/12]

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

◆ Dimension() [12/12]

FrameCPP::Version_8::Dimension::Dimension ( const Previous::Dimension Source)

Member Function Documentation

◆ Bytes() [1/3]

cmn_streamsize_type FrameCPP::Version_8::Dimension::Bytes ( ) const
inline

◆ Bytes() [2/3]

cmn_streamsize_type FrameCPP::Version_8::Dimension::Bytes ( ) const

◆ Bytes() [3/3]

cmn_streamsize_type FrameCPP::Version_8::Dimension::Bytes ( ) const

◆ CalcNData() [1/3]

Dimension::nx_type FrameCPP::Version_8::Dimension::CalcNData ( nDim_type  NDims,
const Dimension Dims 
)
inlinestatic

◆ CalcNData() [2/3]

static nx_type FrameCPP::Version_8::Dimension::CalcNData ( nDim_type  NDims,
const Dimension Dims 
)
static

◆ CalcNData() [3/3]

static nx_type FrameCPP::Version_8::Dimension::CalcNData ( nDim_type  NDims,
const Dimension Dims 
)
static

◆ GetDx() [1/3]

Dimension::dx_type FrameCPP::Version_8::Dimension::GetDx ( ) const
inline

Get the scale factor.

Returns
The scale factor.

◆ GetDx() [2/3]

dx_type FrameCPP::Version_8::Dimension::GetDx ( ) const

Get the scale factor.

Returns
The scale factor.

◆ GetDx() [3/3]

dx_type FrameCPP::Version_8::Dimension::GetDx ( ) const

Get the scale factor.

Returns
The scale factor.

◆ GetNx() [1/3]

Dimension::nx_type FrameCPP::Version_8::Dimension::GetNx ( ) const
inline

Get the dimension length.

Returns
The dimension length.

◆ GetNx() [2/3]

nx_type FrameCPP::Version_8::Dimension::GetNx ( ) const

Get the dimension length.

Returns
The dimension length.

◆ GetNx() [3/3]

nx_type FrameCPP::Version_8::Dimension::GetNx ( ) const

Get the dimension length.

Returns
The dimension length.

◆ GetStartX() [1/3]

Dimension::startX_type FrameCPP::Version_8::Dimension::GetStartX ( ) const
inline

Get data set origin.

Returns
Data set origin.

◆ GetStartX() [2/3]

startX_type FrameCPP::Version_8::Dimension::GetStartX ( ) const

Get data set origin.

Returns
Data set origin.

◆ GetStartX() [3/3]

startX_type FrameCPP::Version_8::Dimension::GetStartX ( ) const

Get data set origin.

Returns
Data set origin.

◆ GetUnitX() [1/3]

const Dimension::unitX_type & FrameCPP::Version_8::Dimension::GetUnitX ( ) const
inline

Get the units.

Returns
The units.

◆ GetUnitX() [2/3]

const unitX_type& FrameCPP::Version_8::Dimension::GetUnitX ( ) const

Get the units.

Returns
The units.

◆ GetUnitX() [3/3]

const unitX_type& FrameCPP::Version_8::Dimension::GetUnitX ( ) const

Get the units.

Returns
The units.

◆ operator!=() [1/3]

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.

◆ operator!=() [2/3]

bool FrameCPP::Version_8::Dimension::operator!= ( const Dimension dim) const

Not equal comparison.

Parameters
[in]dimThe object to compare with.
Returns
false if the objects are equal, true otherwise.

◆ operator!=() [3/3]

bool FrameCPP::Version_8::Dimension::operator!= ( const Dimension dim) const

Not equal comparison.

Parameters
[in]dimThe object to compare with.
Returns
false if the objects are equal, true otherwise.

◆ operator=() [1/3]

const Dimension & FrameCPP::Version_8::Dimension::operator= ( const Dimension dim)
inline

Assignment operator.

Parameters
[in]dimThe object to assign from.
Returns
This object.

◆ operator=() [2/3]

const Dimension& FrameCPP::Version_8::Dimension::operator= ( const Dimension dim)

Assignment operator.

Parameters
[in]dimThe object to assign from.
Returns
This object.

◆ operator=() [3/3]

const Dimension& FrameCPP::Version_8::Dimension::operator= ( const Dimension dim)

Assignment operator.

Parameters
[in]dimThe object to assign from.
Returns
This object.

◆ operator==() [1/3]

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.

◆ operator==() [2/3]

bool FrameCPP::Version_8::Dimension::operator== ( const Dimension dim) const

Equal comparison.

Parameters
[in]dimThe object to compare with.
Returns
true if the objects are equal, false otherwise.

◆ operator==() [3/3]

bool FrameCPP::Version_8::Dimension::operator== ( const Dimension dim) const

Equal comparison.

Parameters
[in]dimThe object to compare with.
Returns
true if the objects are equal, false otherwise.

◆ SetDx() [1/3]

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.

◆ SetDx() [2/3]

void FrameCPP::Version_8::Dimension::SetDx ( dx_type  Dx)

Set sample spacing.

Parameters
[in]DxThe new sample rate for the coordinate.

◆ SetDx() [3/3]

void FrameCPP::Version_8::Dimension::SetDx ( dx_type  Dx)

Set sample spacing.

Parameters
[in]DxThe new sample rate for the coordinate.

◆ SetNx() [1/3]

void FrameCPP::Version_8::Dimension::SetNx ( nx_type  Nx)
inline

Set dimension length.

Parameters
[in]NxThe new dimension length

◆ SetNx() [2/3]

void FrameCPP::Version_8::Dimension::SetNx ( nx_type  Nx)

Set dimension length.

Parameters
[in]NxThe new dimension length

◆ SetNx() [3/3]

void FrameCPP::Version_8::Dimension::SetNx ( nx_type  Nx)

Set dimension length.

Parameters
[in]NxThe new dimension length

◆ SetStartX() [1/3]

void FrameCPP::Version_8::Dimension::SetStartX ( startX_type  StartX)
inline

Set data set origin.

Parameters
[in]StartXData set origin.

◆ SetStartX() [2/3]

void FrameCPP::Version_8::Dimension::SetStartX ( startX_type  StartX)

Set data set origin.

Parameters
[in]StartXData set origin.

◆ SetStartX() [3/3]

void FrameCPP::Version_8::Dimension::SetStartX ( startX_type  StartX)

Set data set origin.

Parameters
[in]StartXData set origin.

◆ SetUnitX() [1/3]

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.

◆ SetUnitX() [2/3]

void FrameCPP::Version_8::Dimension::SetUnitX ( const unitX_type UnitX)

Set scale factor in ASCII.

Parameters
[in]UnitXThe new scale factor description.

◆ SetUnitX() [3/3]

void FrameCPP::Version_8::Dimension::SetUnitX ( const unitX_type UnitX)

Set scale factor in ASCII.

Parameters
[in]UnitXThe new scale factor description.

Member Data Documentation

◆ mDx

dx_type FrameCPP::Version_8::Dimension::mDx
private

Scale factor.

◆ mNx

nx_type FrameCPP::Version_8::Dimension::mNx
private

Dimension length.

◆ mStartX

startX_type FrameCPP::Version_8::Dimension::mStartX
private

Origin.

◆ mUnitX

unitX_type FrameCPP::Version_8::Dimension::mUnitX
private

Scale factor in ASCII.


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