Dimension information for a Vect. More...
#include <Dimension.hh>
Public Types | |
typedef INT_4U | nx_type |
typedef REAL_8 | dx_type |
typedef REAL_8 | startX_type |
typedef INT_4U | nx_type |
typedef REAL_8 | dx_type |
typedef REAL_8 | startX_type |
Public Member Functions | |
Dimension () | |
exc: None. | |
Dimension (const Dimension &dim) | |
Copy constructor. | |
Dimension (const Previous::Dimension &dim) | |
exc: std::bad_alloc - Memory allocation failed. | |
Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0) | |
Constructor. | |
const Dimension & | operator= (const Dimension &dim) |
Assignment operator. | |
bool | operator== (const Dimension &dim) const |
Equal comparison. | |
bool | operator!= (const Dimension &dim) const |
Not equal comparison. | |
nx_type | GetNx () const |
exc: None. | |
dx_type | GetDx () const |
exc: None. | |
startX_type | GetStartX () const |
exc: None. | |
const STRING & | GetUnitX () const |
exc: None. | |
void | SetNx (nx_type Nx) |
cmn_streamsize_type | Bytes () const |
Dimension () | |
exc: None. | |
Dimension (const Dimension &dim) | |
Copy constructor. | |
Dimension (const Previous::Dimension &dim) | |
exc: std::bad_alloc - Memory allocation failed. | |
Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0) | |
Constructor. | |
const Dimension & | operator= (const Dimension &dim) |
Assignment operator. | |
bool | operator== (const Dimension &dim) const |
Equal comparison. | |
bool | operator!= (const Dimension &dim) const |
Not equal comparison. | |
nx_type | GetNx () const |
exc: None. | |
dx_type | GetDx () const |
exc: None. | |
startX_type | GetStartX () const |
exc: None. | |
const STRING & | GetUnitX () const |
exc: None. | |
void | SetNx (nx_type Nx) |
cmn_streamsize_type | Bytes () const |
Private Attributes | |
nx_type | mNx |
Dimension length. | |
dx_type | mDx |
Scale factor. | |
STRING | mUnitX |
Scale factor in ASCII. | |
startX_type | mStartX |
Origin. | |
Dimension information for a Vect.
This is a simple class storing dimension information for a Vect object. It stores the following:
typedef REAL_8 FrameCPP::Version_4::Dimension::dx_type |
typedef REAL_8 FrameCPP::Version_4::Dimension::dx_type |
typedef INT_4U FrameCPP::Version_4::Dimension::nx_type |
typedef INT_4U FrameCPP::Version_4::Dimension::nx_type |
typedef REAL_8 FrameCPP::Version_4::Dimension::startX_type |
typedef REAL_8 FrameCPP::Version_4::Dimension::startX_type |
FrameCPP::Version_4::Dimension::Dimension | ( | ) |
exc: None.
Default Constructor.
This creates a dimension object with the following values:
Dimension Length (Nx) - 1 Scale Factor (Dx) - 1.0 Units (UnitX) - ""
FrameCPP::Version_4::Dimension::Dimension | ( | const Dimension & | dim | ) |
Copy constructor.
This creates a Dimension object with the specified attributes.
[in] | dim | The source from which to construct the new object. |
std::bad_alloc | Memory allocation failed. |
|
inline |
exc: std::bad_alloc - Memory allocation failed.
|
explicit |
Constructor.
This creates a Dimension object with the specified attributes.
[in] | nx | The dimension length. |
[in] | dx | The Scale Factor. |
[in] | unitX | The units (unit per step size). |
[in] | startX | The origin of the data set. |
std::bad_alloc | Memory allocation failed. |
FrameCPP::Version_4::Dimension::Dimension | ( | ) |
exc: None.
FrameCPP::Version_4::Dimension::Dimension | ( | const Dimension & | dim | ) |
Copy constructor.
[in] | dim | The source from which to construct the new object. |
std::bad_alloc | Memory allocation failed. |
FrameCPP::Version_4::Dimension::Dimension | ( | const Previous::Dimension & | dim | ) |
exc: std::bad_alloc - Memory allocation failed.
|
explicit |
Constructor.
[in] | nx | The dimension length. |
[in] | dx | The Scale Factor. |
[in] | unitX | The units (unit per step size). |
[in] | startX | The origin of the data set. |
std::bad_alloc | Memory allocation failed. |
|
inline |
cmn_streamsize_type FrameCPP::Version_4::Dimension::Bytes | ( | ) | const |
|
inline |
exc: None.
Get the scale factor.
dx_type FrameCPP::Version_4::Dimension::GetDx | ( | ) | const |
exc: None.
|
inline |
exc: None.
Get the dimension length.
nx_type FrameCPP::Version_4::Dimension::GetNx | ( | ) | const |
exc: None.
|
inline |
exc: None.
Get data set origin.
startX_type FrameCPP::Version_4::Dimension::GetStartX | ( | ) | const |
exc: None.
|
inline |
exc: None.
Get the units.
const STRING & FrameCPP::Version_4::Dimension::GetUnitX | ( | ) | const |
exc: None.
|
inline |
Not equal comparison.
[in] | dim | The object to compare with. |
bool FrameCPP::Version_4::Dimension::operator!= | ( | const Dimension & | dim | ) | const |
Not equal comparison.
[in] | dim | The object to compare with. |
Assignment operator.
[in] | dim | The object to assign from. |
std::bad_alloc | Memory allocation failed. |
[in] | dim | The object to assign from. |
Assignment operator.
[in] | dim | The object to assign from. |
std::bad_alloc | Memory allocation failed. |
|
inline |
Equal comparison.
[in] | dim | The object to compare with. |
bool FrameCPP::Version_4::Dimension::operator== | ( | const Dimension & | dim | ) | const |
Equal comparison.
[in] | dim | The object to compare with. |
|
inline |
void FrameCPP::Version_4::Dimension::SetNx | ( | nx_type | Nx | ) |
|
private |
Scale factor.
|
private |
Origin.
|
private |
Scale factor in ASCII.