ldas-tools-framecpp  2.7.0
Public Member Functions | List of all members
FrameCPP::Version_4::Dimension Class Reference

Dimension information for a Vect. More...

#include <Dimension.hh>

Public Member Functions

 Dimension ()
 exc: None. More...
 
 Dimension (const Dimension &dim)
 Copy constructor. More...
 
 Dimension (const Previous::Dimension &dim)
 exc: std::bad_alloc - Memory allocation failed.
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0)
 Constructor. More...
 
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
 exc: None. More...
 
dx_type GetDx () const
 exc: None. More...
 
startX_type GetStartX () const
 exc: None. More...
 
const STRING & GetUnitX () const
 exc: None. More...
 
 Dimension ()
 exc: None.
 
 Dimension (const Dimension &dim)
 Copy constructor. More...
 
 Dimension (const Previous::Dimension &dim)
 exc: std::bad_alloc - Memory allocation failed.
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0)
 Constructor. More...
 
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
 exc: None.
 
dx_type GetDx () const
 exc: None.
 
startX_type GetStartX () const
 exc: None.
 
const STRING & GetUnitX () const
 exc: None.
 

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).

Constructor & Destructor Documentation

◆ Dimension() [1/5]

FrameCPP::Version_4::Dimension::Dimension ( )

exc: None.

Default Constructor.

This creates a dimension object with the following values:

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

◆ Dimension() [2/5]

FrameCPP::Version_4::Dimension::Dimension ( const Dimension dim)

Copy constructor.

This creates a Dimension object with the specified attributes.

Parameters
[in]dimThe source from which to construct the new object.
Exceptions
std::bad_allocMemory allocation failed.

◆ Dimension() [3/5]

FrameCPP::Version_4::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/5]

FrameCPP::Version_4::Dimension::Dimension ( const Dimension dim)

Copy constructor.

Parameters
[in]dimThe source from which to construct the new object.
Exceptions
std::bad_allocMemory allocation failed.

◆ Dimension() [5/5]

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

Constructor.

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.

Member Function Documentation

◆ GetDx()

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

exc: None.

Get the scale factor.

Returns
The scale factor.

◆ GetNx()

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

exc: None.

Get the dimension length.

Returns
The dimension length.

◆ GetStartX()

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

exc: None.

Get data set origin.

Returns
Data set origin.

◆ GetUnitX()

const STRING & FrameCPP::Version_4::Dimension::GetUnitX ( ) const
inline

exc: None.

Get the units.

Returns
The units.

◆ operator!=() [1/2]

bool FrameCPP::Version_4::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/2]

bool FrameCPP::Version_4::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/2]

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

Assignment operator.

Parameters
[in]dimThe object to assign from.
Returns
This object.
Exceptions
std::bad_allocMemory allocation failed.
Parameters
[in]dimThe object to assign from.
Returns
This object.

◆ operator=() [2/2]

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

Assignment operator.

Parameters
[in]dimThe object to assign from.
Returns
This object.
Exceptions
std::bad_allocMemory allocation failed.

◆ operator==() [1/2]

bool FrameCPP::Version_4::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/2]

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

Equal comparison.

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

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