ldas-tools-framecpp
2.8.1
|
Dimension information for a Vect. More...
#include <Dimension.hh>
Public Member Functions | |
Dimension () | |
Default Constructor. More... | |
Dimension (const Dimension &dim) | |
Copy constructor. More... | |
Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="", startX_type startX=0.0) | |
Constructor. More... | |
const Dimension & | operator= (const Dimension &dim) |
Assignment operator. More... | |
bool | operator== (const Dimension &dim) const |
Equal comparison. More... | |
bool | operator!= (const Dimension &dim) const |
Not equal comparison. More... | |
nx_type | GetNx () const |
Get the dimension length. More... | |
dx_type | GetDx () const |
Get the scale factor. More... | |
startX_type | GetStartX () const |
Get data set origin. More... | |
const unitX_type & | GetUnitX () const |
Get the units. More... | |
void | SetDx (dx_type Dx) |
Set sample spacing. More... | |
void | SetNx (nx_type Nx) |
Set dimension length. More... | |
void | SetStartX (startX_type StartX) |
Set data set origin. More... | |
void | SetUnitX (const unitX_type &UnitX) |
Set scale factor in ASCII. More... | |
const Dimension & | operator= (const Dimension &dim) |
Assignment operator. More... | |
bool | operator== (const Dimension &dim) const |
Equal comparison. More... | |
bool | operator!= (const Dimension &dim) const |
Not equal comparison. More... | |
nx_type | GetNx () const |
Get the dimension length. More... | |
dx_type | GetDx () const |
Get the scale factor. More... | |
startX_type | GetStartX () const |
Get data set origin. More... | |
const unitX_type & | GetUnitX () const |
Get the units. More... | |
void | SetDx (dx_type Dx) |
Set sample spacing. More... | |
void | SetNx (nx_type Nx) |
Set dimension length. More... | |
void | SetStartX (startX_type StartX) |
Set data set origin. More... | |
void | SetUnitX (const unitX_type &UnitX) |
Set scale factor in ASCII. More... | |
const Dimension & | operator= (const Dimension &dim) |
Assignment operator. More... | |
bool | operator== (const Dimension &dim) const |
Equal comparison. More... | |
bool | operator!= (const Dimension &dim) const |
Not equal comparison. More... | |
nx_type | GetNx () const |
Get the dimension length. More... | |
dx_type | GetDx () const |
Get the scale factor. More... | |
startX_type | GetStartX () const |
Get data set origin. More... | |
const unitX_type & | GetUnitX () const |
Get the units. More... | |
void | SetDx (dx_type Dx) |
Set sample spacing. More... | |
void | SetNx (nx_type Nx) |
Set dimension length. More... | |
void | SetStartX (startX_type StartX) |
Set data set origin. More... | |
void | SetUnitX (const unitX_type &UnitX) |
Set scale factor in ASCII. More... | |
Dimension information for a Vect.
This is a simple class storing dimension information for a Vect object. It stores the following:
FrameCPP::Version_8::Dimension::Dimension | ( | ) |
Default Constructor.
This creates a dimension object with the following values:
Dimension Length (Nx) - 1 Scale Factor (Dx) - 1.0 Units (UnitX) - ""
FrameCPP::Version_8::Dimension::Dimension | ( | const Dimension & | dim | ) |
Copy constructor.
[in] | dim | The Dimension to copy from. |
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. |
|
inline |
Get the scale factor.
dx_type FrameCPP::Version_8::Dimension::GetDx | ( | ) | const |
Get the scale factor.
dx_type FrameCPP::Version_8::Dimension::GetDx | ( | ) | const |
Get the scale factor.
|
inline |
Get the dimension length.
nx_type FrameCPP::Version_8::Dimension::GetNx | ( | ) | const |
Get the dimension length.
nx_type FrameCPP::Version_8::Dimension::GetNx | ( | ) | const |
Get the dimension length.
|
inline |
Get data set origin.
startX_type FrameCPP::Version_8::Dimension::GetStartX | ( | ) | const |
Get data set origin.
startX_type FrameCPP::Version_8::Dimension::GetStartX | ( | ) | const |
Get data set origin.
|
inline |
Get the units.
const unitX_type& FrameCPP::Version_8::Dimension::GetUnitX | ( | ) | const |
Get the units.
const unitX_type& FrameCPP::Version_8::Dimension::GetUnitX | ( | ) | const |
Get the units.
|
inline |
Not equal comparison.
[in] | dim | The object to compare with. |
bool FrameCPP::Version_8::Dimension::operator!= | ( | const Dimension & | dim | ) | const |
Not equal comparison.
[in] | dim | The object to compare with. |
bool FrameCPP::Version_8::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. |
Assignment operator.
[in] | dim | The object to assign from. |
Assignment operator.
[in] | dim | The object to assign from. |
|
inline |
Equal comparison.
[in] | dim | The object to compare with. |
bool FrameCPP::Version_8::Dimension::operator== | ( | const Dimension & | dim | ) | const |
Equal comparison.
[in] | dim | The object to compare with. |
bool FrameCPP::Version_8::Dimension::operator== | ( | const Dimension & | dim | ) | const |
Equal comparison.
[in] | dim | The object to compare with. |
|
inline |
Set sample spacing.
Establish a new value for sample spacing along the coordinate.
[in] | Dx | The new sample rate for the coordinate. |
void FrameCPP::Version_8::Dimension::SetDx | ( | dx_type | Dx | ) |
Set sample spacing.
[in] | Dx | The new sample rate for the coordinate. |
void FrameCPP::Version_8::Dimension::SetDx | ( | dx_type | Dx | ) |
Set sample spacing.
[in] | Dx | The new sample rate for the coordinate. |
|
inline |
Set dimension length.
[in] | Nx | The new dimension length |
void FrameCPP::Version_8::Dimension::SetNx | ( | nx_type | Nx | ) |
Set dimension length.
[in] | Nx | The new dimension length |
void FrameCPP::Version_8::Dimension::SetNx | ( | nx_type | Nx | ) |
Set dimension length.
[in] | Nx | The new dimension length |
|
inline |
Set data set origin.
[in] | StartX | Data set origin. |
void FrameCPP::Version_8::Dimension::SetStartX | ( | startX_type | StartX | ) |
Set data set origin.
[in] | StartX | Data set origin. |
void FrameCPP::Version_8::Dimension::SetStartX | ( | startX_type | StartX | ) |
Set data set origin.
[in] | StartX | Data set origin. |
|
inline |
Set scale factor in ASCII.
Establish a new value for sample spacing along the coordinate.
[in] | UnitX | The new scale factor description. |
void FrameCPP::Version_8::Dimension::SetUnitX | ( | const unitX_type & | UnitX | ) |
Set scale factor in ASCII.
[in] | UnitX | The new scale factor description. |
void FrameCPP::Version_8::Dimension::SetUnitX | ( | const unitX_type & | UnitX | ) |
Set scale factor in ASCII.
[in] | UnitX | The new scale factor description. |