Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Dimension

Dimension information for a Vect.
Contained in: FrameCPP::Version_3_4_5
Derived from: none
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/dimension.hh"


public function member index:

inline Dimension(); Default Constructor.
inline Dimension(const Dimension& dim); Copy constructor.
inline explicit Dimension(INT_4U nx, REAL_8 dx = 1.0, const std::string& unitX = "", REAL_8 startX = 0.0); Constructor.
inline REAL_8 getDx() const; Get the scale factor.
inline INT_4U getNx() const; Get the dimension length.
inline REAL_8 getStartX() const; Get data set origin.
inline const std::string& getUnitX() const; Get the units.
bool operator !=(const Dimension& dim) const; Not equal comparison.
const Dimension& operator =(const Dimension& dim); Assignment operator.
bool operator ==(const Dimension& dim) const; Equal comparison.
 

Description:

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


Function Member Descriptions:


FrameCPP::Version_3_4_5::Dimension::Dimension - Default Constructor.


inline Dimension();
This creates a dimension object with the following values: Dimension Length (Nx) - 1 Scale Factor (Dx) - 1.0 Units (UnitX) - ""

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Dimension::Dimension - Copy constructor.


inline Dimension(const Dimension& dim);

Parameters:
ParameterDescription
const Dimension& dimThe Dimension to copy from.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Dimension::Dimension - Constructor.


inline explicit Dimension(INT_4U nx, REAL_8 dx = 1.0, const std::string& unitX = "", REAL_8 startX = 0.0);
This creates a Dimension object with the specified attributes.

Parameters:
ParameterDescription
INT_4U nxThe dimension length.
REAL_8 dxThe Scale Factor. Default: 1.0
const std::string& unitXThe units (unit per step size). Default: ""

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Dimension::getDx - Get the scale factor.


inline REAL_8 getDx() const;

Return value:
REAL_8- The scale factor.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Dimension::getNx - Get the dimension length.


inline INT_4U getNx() const;

Return value:
INT_4U- The dimension length.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Dimension::getStartX - Get data set origin.


inline REAL_8 getStartX() const;

Return value:
REAL_8- Data set origin.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Dimension::getUnitX - Get the units.


inline const std::string& getUnitX() const;

Return value:
const std::string&- The units.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Dimension::operator != - Not equal comparison.


bool operator !=(const Dimension& dim) const;

Parameters:
ParameterDescription
const Dimension& dimThe object to compare with.

Return value:
bool- false if the objects are equal, true otherwise.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Dimension::operator = - Assignment operator.


const Dimension& operator =(const Dimension& dim);

Parameters:
ParameterDescription
const Dimension& dimThe object to assign from.

Return value:
const Dimension&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Dimension::operator == - Equal comparison.


bool operator ==(const Dimension& dim) const;

Parameters:
ParameterDescription
const Dimension& dimThe object to compare with.

Return value:
bool- true if the objects are equal, false otherwise.

Exceptions:
ExceptionDescription
None.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Dimension::mDx - Scale factor.

REAL_8 mDx;

FrameCPP::Version_3_4_5::Dimension::mNx - Dimension length.

INT_4U mNx;

FrameCPP::Version_3_4_5::Dimension::mStartX - Origin.

REAL_8 mStartX;

FrameCPP::Version_3_4_5::Dimension::mUnitX - Scale factor in ASCII.

std::string mUnitX;