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

#include <Dimension.hh>

Public Types

typedef INT_8U nx_type
 
typedef REAL_8 dx_type
 
typedef REAL_8 startX_type
 
typedef INT_8U nx_type
 
typedef REAL_8 dx_type
 
typedef REAL_8 startX_type
 
typedef INT_8U nx_type
 
typedef REAL_8 dx_type
 
typedef REAL_8 startX_type
 

Public Member Functions

 Dimension ()
 exc: None. More...
 
 Dimension (const Dimension &dim)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (INT_8U nx, REAL_8 dx=1.0, const std::string &unitX="", REAL_8 startX=0.0)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (const Previous::Dimension &Source)
 
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...
 
INT_8U GetNx () const
 exc: None. More...
 
REAL_8 GetDx () const
 exc: None. More...
 
REAL_8 GetStartX () const
 exc: None. More...
 
const STRINGGetUnitX () const
 exc: None. More...
 
void SetNx (INT_8U Nx)
 
cmn_streamsize_type Bytes () const
 
 Dimension ()
 exc: None. More...
 
 Dimension (const Dimension &dim)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (INT_8U nx, REAL_8 dx=1.0, const std::string &unitX="", REAL_8 startX=0.0)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (const Previous::Dimension &Source)
 
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...
 
INT_8U GetNx () const
 exc: None. More...
 
REAL_8 GetDx () const
 exc: None. More...
 
REAL_8 GetStartX () const
 exc: None. More...
 
const STRINGGetUnitX () const
 exc: None. More...
 
void SetNx (INT_8U Nx)
 
cmn_streamsize_type Bytes () const
 
 Dimension ()
 exc: None. More...
 
 Dimension (const Dimension &dim)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (INT_8U nx, REAL_8 dx=1.0, const std::string &unitX="", REAL_8 startX=0.0)
 exc: std::bad_alloc - Memory allocation failed. More...
 
 Dimension (const Previous::Dimension &Source)
 
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...
 
INT_8U GetNx () const
 exc: None. More...
 
REAL_8 GetDx () const
 exc: None. More...
 
REAL_8 GetStartX () const
 exc: None. More...
 
const STRINGGetUnitX () const
 exc: None. More...
 
void SetNx (INT_8U Nx)
 
cmn_streamsize_type Bytes () const
 

Private Attributes

INT_8U mNx
 
REAL_8 mDx
 
STRING mUnitX
 
REAL_8 mStartX
 

Member Typedef Documentation

◆ dx_type [1/3]

typedef REAL_8 FrameCPP::Version_6::Dimension::dx_type

◆ dx_type [2/3]

typedef REAL_8 FrameCPP::Version_6::Dimension::dx_type

◆ dx_type [3/3]

typedef REAL_8 FrameCPP::Version_6::Dimension::dx_type

◆ nx_type [1/3]

typedef INT_8U FrameCPP::Version_6::Dimension::nx_type

◆ nx_type [2/3]

typedef INT_8U FrameCPP::Version_6::Dimension::nx_type

◆ nx_type [3/3]

typedef INT_8U FrameCPP::Version_6::Dimension::nx_type

◆ startX_type [1/3]

typedef REAL_8 FrameCPP::Version_6::Dimension::startX_type

◆ startX_type [2/3]

typedef REAL_8 FrameCPP::Version_6::Dimension::startX_type

◆ startX_type [3/3]

typedef REAL_8 FrameCPP::Version_6::Dimension::startX_type

Constructor & Destructor Documentation

◆ Dimension() [1/12]

FrameCPP::Version_6::Dimension::Dimension ( )

exc: None.

◆ Dimension() [2/12]

FrameCPP::Version_6::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/12]

FrameCPP::Version_6::Dimension::Dimension ( INT_8U  nx,
REAL_8  dx = 1.0,
const std::string &  unitX = "",
REAL_8  startx = 0.0 
)
explicit

exc: std::bad_alloc - Memory allocation failed.

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_6::Dimension::Dimension ( const Previous::Dimension Source)
inline

◆ Dimension() [5/12]

FrameCPP::Version_6::Dimension::Dimension ( )

exc: None.

◆ Dimension() [6/12]

FrameCPP::Version_6::Dimension::Dimension ( const Dimension dim)

exc: std::bad_alloc - Memory allocation failed.

◆ Dimension() [7/12]

FrameCPP::Version_6::Dimension::Dimension ( INT_8U  nx,
REAL_8  dx = 1.0,
const std::string &  unitX = "",
REAL_8  startX = 0.0 
)
explicit

exc: std::bad_alloc - Memory allocation failed.

◆ Dimension() [8/12]

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

◆ Dimension() [9/12]

FrameCPP::Version_6::Dimension::Dimension ( )

exc: None.

◆ Dimension() [10/12]

FrameCPP::Version_6::Dimension::Dimension ( const Dimension dim)

exc: std::bad_alloc - Memory allocation failed.

◆ Dimension() [11/12]

FrameCPP::Version_6::Dimension::Dimension ( INT_8U  nx,
REAL_8  dx = 1.0,
const std::string &  unitX = "",
REAL_8  startX = 0.0 
)
explicit

exc: std::bad_alloc - Memory allocation failed.

◆ Dimension() [12/12]

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

Member Function Documentation

◆ Bytes() [1/3]

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

◆ Bytes() [2/3]

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

◆ Bytes() [3/3]

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

◆ GetDx() [1/3]

REAL_8 FrameCPP::Version_6::Dimension::GetDx ( ) const
inline

exc: None.

return: REAL_8 – The scale factor.

exc: None.

◆ GetDx() [2/3]

REAL_8 FrameCPP::Version_6::Dimension::GetDx ( ) const

exc: None.

◆ GetDx() [3/3]

REAL_8 FrameCPP::Version_6::Dimension::GetDx ( ) const

exc: None.

◆ GetNx() [1/3]

INT_8U FrameCPP::Version_6::Dimension::GetNx ( ) const
inline

exc: None.

return: INT_8U – The dimension length.

exc: None.

◆ GetNx() [2/3]

INT_8U FrameCPP::Version_6::Dimension::GetNx ( ) const

exc: None.

◆ GetNx() [3/3]

INT_8U FrameCPP::Version_6::Dimension::GetNx ( ) const

exc: None.

◆ GetStartX() [1/3]

REAL_8 FrameCPP::Version_6::Dimension::GetStartX ( ) const
inline

exc: None.

return: REAL_8 – Data set origin.

exc: None.

◆ GetStartX() [2/3]

REAL_8 FrameCPP::Version_6::Dimension::GetStartX ( ) const

exc: None.

◆ GetStartX() [3/3]

REAL_8 FrameCPP::Version_6::Dimension::GetStartX ( ) const

exc: None.

◆ GetUnitX() [1/3]

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

exc: None.

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

exc: None.

◆ GetUnitX() [2/3]

const STRING& FrameCPP::Version_6::Dimension::GetUnitX ( ) const

exc: None.

◆ GetUnitX() [3/3]

const STRING& FrameCPP::Version_6::Dimension::GetUnitX ( ) const

exc: None.

◆ operator!=() [1/3]

bool FrameCPP::Version_6::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!=() [2/3]

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

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

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

◆ operator!=() [3/3]

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

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

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

◆ operator=() [1/3]

const Dimension & FrameCPP::Version_6::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=() [2/3]

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

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

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

◆ operator=() [3/3]

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

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

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

◆ operator==() [1/3]

bool FrameCPP::Version_6::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.

◆ operator==() [2/3]

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

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

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

◆ operator==() [3/3]

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

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

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

◆ SetNx() [1/3]

void FrameCPP::Version_6::Dimension::SetNx ( INT_8U  Nx)
inline

◆ SetNx() [2/3]

void FrameCPP::Version_6::Dimension::SetNx ( INT_8U  Nx)

◆ SetNx() [3/3]

void FrameCPP::Version_6::Dimension::SetNx ( INT_8U  Nx)

Member Data Documentation

◆ mDx

REAL_8 FrameCPP::Version_6::Dimension::mDx
private

◆ mNx

INT_8U FrameCPP::Version_6::Dimension::mNx
private

◆ mStartX

REAL_8 FrameCPP::Version_6::Dimension::mStartX
private

◆ mUnitX

STRING FrameCPP::Version_6::Dimension::mUnitX
private

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