ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | 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
 

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
 

Member Typedef Documentation

Constructor & Destructor Documentation

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

exc: None.

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.

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.
FrameCPP::Version_6::Dimension::Dimension ( const Previous::Dimension &  Source)
inline

Member Function Documentation

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

exc: None.

return: REAL_8 – The scale factor.

exc: None.

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

exc: None.

return: INT_8U – The dimension length.

exc: None.

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

exc: None.

return: REAL_8 – Data set origin.

exc: None.

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

exc: None.

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

exc: None.

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.

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.

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.

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

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