Dimension information for a Vect.
More...
#include <Dimension.hh>
|
| Dimension () |
| Default Constructor.
|
| Dimension (const Dimension &dim) |
| Copy constructor.
|
| 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 |
| Get the dimension length.
|
dx_type | GetDx () const |
| Get the scale factor.
|
startX_type | GetStartX () const |
| Get data set origin.
|
const unitX_type & | GetUnitX () const |
| Get the units.
|
void | SetDx (dx_type Dx) |
| Set sample spacing.
|
void | SetNx (nx_type Nx) |
| Set dimension length.
|
void | SetStartX (startX_type StartX) |
| Set data set origin.
|
void | SetUnitX (const unitX_type &UnitX) |
| Set scale factor in ASCII.
|
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 |
| Get the dimension length.
|
dx_type | GetDx () const |
| Get the scale factor.
|
startX_type | GetStartX () const |
| Get data set origin.
|
const unitX_type & | GetUnitX () const |
| Get the units.
|
void | SetDx (dx_type Dx) |
| Set sample spacing.
|
void | SetNx (nx_type Nx) |
| Set dimension length.
|
void | SetStartX (startX_type StartX) |
| Set data set origin.
|
void | SetUnitX (const unitX_type &UnitX) |
| Set scale factor in ASCII.
|
Dimension information for a Vect.
This is a simple class storing dimension information for a Vect object. It stores the following:
-
The dimension length.
-
Scale factor
-
The units (unit per step size along the coordintate).
◆ Dimension() [1/3]
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) - ""
◆ Dimension() [2/3]
FrameCPP::Version_8::Dimension::Dimension |
( |
const Dimension & | dim | ) |
|
Copy constructor.
- Parameters
-
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ Dimension() [3/3]
FrameCPP::Version_8::Dimension::Dimension |
( |
nx_type | nx, |
|
|
dx_type | dx = 1.0, |
|
|
const std::string & | unitX = "", |
|
|
startX_type | startx = 0.0 ) |
|
explicit |
Constructor.
This creates a Dimension object with the specified attributes.
- Parameters
-
[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. |
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ GetDx() [1/2]
Dimension::dx_type FrameCPP::Version_8::Dimension::GetDx |
( |
| ) |
const |
|
inline |
Get the scale factor.
- Returns
- The scale factor.
◆ GetDx() [2/2]
dx_type FrameCPP::Version_8::Dimension::GetDx |
( |
| ) |
const |
Get the scale factor.
- Returns
- The scale factor.
◆ GetNx() [1/2]
Dimension::nx_type FrameCPP::Version_8::Dimension::GetNx |
( |
| ) |
const |
|
inline |
Get the dimension length.
- Returns
- The dimension length.
◆ GetNx() [2/2]
nx_type FrameCPP::Version_8::Dimension::GetNx |
( |
| ) |
const |
Get the dimension length.
- Returns
- The dimension length.
◆ GetStartX() [1/2]
Dimension::startX_type FrameCPP::Version_8::Dimension::GetStartX |
( |
| ) |
const |
|
inline |
Get data set origin.
- Returns
- Data set origin.
◆ GetStartX() [2/2]
startX_type FrameCPP::Version_8::Dimension::GetStartX |
( |
| ) |
const |
Get data set origin.
- Returns
- Data set origin.
◆ GetUnitX() [1/2]
const Dimension::unitX_type & FrameCPP::Version_8::Dimension::GetUnitX |
( |
| ) |
const |
|
inline |
Get the units.
- Returns
- The units.
◆ GetUnitX() [2/2]
const unitX_type & FrameCPP::Version_8::Dimension::GetUnitX |
( |
| ) |
const |
Get the units.
- Returns
- The units.
◆ operator!=() [1/2]
bool FrameCPP::Version_8::Dimension::operator!= |
( |
const Dimension & | dim | ) |
const |
|
inline |
Not equal comparison.
- Parameters
-
[in] | dim | The object to compare with. |
- Returns
- false if the objects are equal, true otherwise.
◆ operator!=() [2/2]
bool FrameCPP::Version_8::Dimension::operator!= |
( |
const Dimension & | dim | ) |
const |
Not equal comparison.
- Parameters
-
[in] | dim | The object to compare with. |
- Returns
- false if the objects are equal, true otherwise.
◆ operator=() [1/2]
Assignment operator.
- Parameters
-
[in] | dim | The object to assign from. |
- Returns
- This object.
◆ operator=() [2/2]
Assignment operator.
- Parameters
-
[in] | dim | The object to assign from. |
- Returns
- This object.
◆ operator==() [1/2]
bool FrameCPP::Version_8::Dimension::operator== |
( |
const Dimension & | dim | ) |
const |
|
inline |
Equal comparison.
- Parameters
-
[in] | dim | The object to compare with. |
- Returns
- true if the objects are equal, false otherwise.
◆ operator==() [2/2]
bool FrameCPP::Version_8::Dimension::operator== |
( |
const Dimension & | dim | ) |
const |
Equal comparison.
- Parameters
-
[in] | dim | The object to compare with. |
- Returns
- true if the objects are equal, false otherwise.
◆ SetDx() [1/2]
void FrameCPP::Version_8::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. |
◆ SetDx() [2/2]
void FrameCPP::Version_8::Dimension::SetDx |
( |
dx_type | Dx | ) |
|
Set sample spacing.
- Parameters
-
[in] | Dx | The new sample rate for the coordinate. |
◆ SetNx() [1/2]
void FrameCPP::Version_8::Dimension::SetNx |
( |
nx_type | Nx | ) |
|
|
inline |
Set dimension length.
- Parameters
-
[in] | Nx | The new dimension length |
◆ SetNx() [2/2]
void FrameCPP::Version_8::Dimension::SetNx |
( |
nx_type | Nx | ) |
|
Set dimension length.
- Parameters
-
[in] | Nx | The new dimension length |
◆ SetStartX() [1/2]
void FrameCPP::Version_8::Dimension::SetStartX |
( |
startX_type | StartX | ) |
|
|
inline |
Set data set origin.
- Parameters
-
[in] | StartX | Data set origin. |
◆ SetStartX() [2/2]
void FrameCPP::Version_8::Dimension::SetStartX |
( |
startX_type | StartX | ) |
|
Set data set origin.
- Parameters
-
[in] | StartX | Data set origin. |
◆ SetUnitX() [1/2]
void FrameCPP::Version_8::Dimension::SetUnitX |
( |
const unitX_type & | 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. |
◆ SetUnitX() [2/2]
void FrameCPP::Version_8::Dimension::SetUnitX |
( |
const unitX_type & | UnitX | ) |
|
Set scale factor in ASCII.
- Parameters
-
[in] | UnitX | The new scale factor description. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version8/Dimension.hh
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/Dimension.hh
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/Dimension.cc