#include <Dimension.hh>
FrameCPP::Version_3::Dimension::Dimension |
( |
| ) |
|
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.
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: ""
exc: None.
return: REAL_8 – The scale factor.
exc: None.
exc: None.
return: INT_8U – The dimension length.
exc: None.
const STRING & FrameCPP::Version_3::Dimension::GetUnitX |
( |
| ) |
const |
|
inline |
exc: None.
return: const std::string& – The units.
exc: None.
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.
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_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.
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] | Dx | The new sample rate for the coordinate. |
void FrameCPP::Version_3::Dimension::SetNx |
( |
nx_type |
Nx | ) |
|
|
inline |
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] | UnitX | The new scale factor description. |
The documentation for this class was generated from the following files: