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

#include <Dimension.hh>

Public Types

typedef INT_4U nx_type
 
typedef REAL_8 dx_type
 

Public Member Functions

 Dimension ()
 exc: None. More...
 
 Dimension (const Dimension &dim)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="")
 exc: std::bad_alloc - Memory allocation failed. More...
 
const Dimensionoperator= (const Dimension &dim)
 param: const Dimension& dim - The object to assign from. More...
 
bool operator== (const Dimension &dim) const
 param: const Dimension& dim - The object to compare with. More...
 
bool operator!= (const Dimension &dim) const
 param: const Dimension& dim - The object to compare with. More...
 
nx_type GetNx () const
 exc: None. More...
 
dx_type GetDx () const
 exc: None. More...
 
const STRINGGetUnitX () const
 exc: None. More...
 
void SetDx (dx_type Dx)
 Set sample spacing. More...
 
void SetNx (nx_type Nx)
 
void SetUnitX (const STRING &UnitX)
 Set scale factor in ASCII. More...
 
cmn_streamsize_type Bytes () const
 

Member Typedef Documentation

◆ dx_type

◆ nx_type

Constructor & Destructor Documentation

◆ Dimension() [1/3]

FrameCPP::Version_3::Dimension::Dimension ( )

exc: None.

◆ Dimension() [2/3]

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

exc: std::bad_alloc - Memory allocation failed.

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

exc: std::bad_alloc - Memory allocation failed.

◆ Dimension() [3/3]

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

exc: std::bad_alloc - Memory allocation failed.

param: INT_8U nx - The dimension length. param: REAL_8 dx - The Scale Factor. Default: 1.0 param: const std::string& unitX - The units (unit per step size). Default: ""

Member Function Documentation

◆ Bytes()

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

◆ GetDx()

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

exc: None.

return: REAL_8 – The scale factor.

exc: None.

◆ GetNx()

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

exc: None.

return: INT_8U – The dimension length.

exc: None.

◆ GetUnitX()

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

exc: None.

return: const std::string& – The units.

exc: None.

◆ operator!=()

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

param: const Dimension& dim - The object to compare with.

return: bool – false if the objects are equal, true otherwise. exc: None.

return: bool - false if the objects are equal, true otherwise. exc: None.

◆ operator=()

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

param: const Dimension& dim - The object to assign from.

return: const Dimension& – This object. exc: std::bad_alloc - Memory allocation failed.

return: const Dimension& - This object. exc: std::bad_alloc - Memory allocation failed.

◆ operator==()

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

param: const Dimension& dim - The object to compare with.

return: bool – true if the objects are equal, false otherwise. exc: None.

return: bool - true if the objects are equal, false otherwise. exc: None.

◆ SetDx()

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.

◆ SetNx()

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

◆ SetUnitX()

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.

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