Class Index | Cross Index | Namespace Index |
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. |
This creates a dimension object with the following values: Dimension Length (Nx) - 1 Scale Factor (Dx) - 1.0 Units (UnitX) - ""
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const Dimension& dim | The Dimension to copy from. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
This creates a Dimension object with the specified attributes.
Parameters:
Parameter | Description |
INT_4U nx | The dimension length. |
REAL_8 dx | The Scale Factor. Default: 1.0 |
const std::string& unitX | The units (unit per step size). Default: "" |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
Return value:
REAL_8- The scale factor.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_4U- The dimension length.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
REAL_8- Data set origin.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const std::string&- The units.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const Dimension& dim | The object to compare with. |
Return value:
bool- false if the objects are equal, true otherwise.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Dimension& dim | The object to assign from. |
Return value:
const Dimension&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const Dimension& dim | The object to compare with. |
Return value:
bool- true if the objects are equal, false otherwise.
Exceptions:
Exception | Description |
None. |