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

Dimension information for a Vect. More...

#include <Dimension.hh>

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="")
 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
 Get the dimension length. More...
 
dx_type GetDx () const
 Get the scale factor. More...
 
const STRING & GetUnitX () const
 Get the units. More...
 
void SetDx (dx_type Dx)
 Set sample spacing. More...
 
void SetUnitX (const STRING &UnitX)
 Set scale factor in ASCII. More...
 
 Dimension (const Dimension &dim)
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="")
 
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...
 
void SetDx (dx_type Dx)
 Set sample spacing. More...
 
void SetUnitX (const STRING &UnitX)
 Set scale factor in ASCII. 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).

Constructor & Destructor Documentation

◆ Dimension() [1/5]

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

FrameCPP::Version_3::Dimension::Dimension ( const Dimension dim)

Copy constructor.

Exceptions
std::bad_allocMemory allocation failed.
Parameters
[ion]dim - The Dimension to copy from.

\excpetion std::bad_alloc Memory allocation failed.

◆ Dimension() [3/5]

FrameCPP::Version_3::Dimension::Dimension ( nx_type  nx,
dx_type  dx = 1.0,
const std::string &  unitX = "" 
)
explicit

Constructor.

\excpetion std::bad_alloc Memory allocation failed.

This creates a Dimension object with the specified attributes.

Parameters
[in]nxThe dimension length.
[in]dxThe Scale Factor. Default: 1.0
[in]unitXThe units (unit per step size).
Exceptions
std::bad_allocMemory allocation failed.

◆ Dimension() [4/5]

FrameCPP::Version_3::Dimension::Dimension ( const Dimension dim)
Exceptions
std::bad_allocMemory allocation failed.

◆ Dimension() [5/5]

FrameCPP::Version_3::Dimension::Dimension ( nx_type  nx,
dx_type  dx = 1.0,
const std::string &  unitX = "" 
)
explicit

\excpetion std::bad_alloc Memory allocation failed.

Member Function Documentation

◆ GetDx()

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

Get the scale factor.

Returns
The scale factor.

◆ GetNx()

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

Get the dimension length.

Returns
The dimension length.

◆ GetUnitX()

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

Get the units.

Returns
The units.

◆ operator!=() [1/2]

bool FrameCPP::Version_3::Dimension::operator!= ( const Dimension dim) const
inline

Not equal comparison.

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

◆ operator!=() [2/2]

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

Not equal comparison.

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

◆ operator=() [1/2]

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

Assignment operator.

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

◆ operator=() [2/2]

const Dimension& FrameCPP::Version_3::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_3::Dimension::operator== ( const Dimension dim) const
inline

Equal comparison.

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

◆ operator==() [2/2]

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

Equal comparison.

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

◆ SetDx() [1/2]

void FrameCPP::Version_3::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/2]

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

Set sample spacing.

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

◆ SetUnitX() [1/2]

void FrameCPP::Version_3::Dimension::SetUnitX ( const STRING &  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/2]

void FrameCPP::Version_3::Dimension::SetUnitX ( const STRING &  UnitX)

Set scale factor in ASCII.

Parameters
[in]UnitXThe new scale factor description.

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