Dimension information for a Vect.
More...
#include <Dimension.hh>
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/7]
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) - ""
◆ Dimension() [2/7]
FrameCPP::Version_4::Dimension::Dimension |
( |
const Dimension & |
dim | ) |
|
Copy constructor.
This creates a Dimension object with the specified attributes.
- Parameters
-
[in] | dim | The source from which to construct the new object. |
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ Dimension() [3/7]
FrameCPP::Version_4::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. |
◆ Dimension() [4/7]
FrameCPP::Version_4::Dimension::Dimension |
( |
const Dimension & |
dim | ) |
|
Copy constructor.
- Parameters
-
[in] | dim | The source from which to construct the new object. |
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ Dimension() [5/7]
FrameCPP::Version_4::Dimension::Dimension |
( |
nx_type |
nx, |
|
|
dx_type |
dx = 1.0 , |
|
|
const std::string & |
unitX = "" , |
|
|
startX_type |
startX = 0.0 |
|
) |
| |
|
explicit |
Constructor.
- 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. |
◆ Dimension() [6/7]
FrameCPP::Version_4::Dimension::Dimension |
( |
const Dimension & |
dim | ) |
|
Copy constructor.
- Parameters
-
[in] | dim | The source from which to construct the new object. |
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ Dimension() [7/7]
FrameCPP::Version_4::Dimension::Dimension |
( |
nx_type |
nx, |
|
|
dx_type |
dx = 1.0 , |
|
|
const std::string & |
unitX = "" , |
|
|
startX_type |
startX = 0.0 |
|
) |
| |
|
explicit |
Constructor.
- 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()
Dimension::dx_type FrameCPP::Version_4::Dimension::GetDx |
( |
| ) |
const |
|
inline |
exc: None.
Get the scale factor.
- Returns
- The scale factor.
◆ GetNx()
Dimension::nx_type FrameCPP::Version_4::Dimension::GetNx |
( |
| ) |
const |
|
inline |
exc: None.
Get the dimension length.
- Returns
- The dimension length.
◆ GetStartX()
Dimension::startX_type FrameCPP::Version_4::Dimension::GetStartX |
( |
| ) |
const |
|
inline |
exc: None.
Get data set origin.
- Returns
- Data set origin.
◆ GetUnitX()
const STRING & FrameCPP::Version_4::Dimension::GetUnitX |
( |
| ) |
const |
|
inline |
exc: None.
Get the units.
- Returns
- The units.
◆ operator!=() [1/3]
bool FrameCPP::Version_4::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/3]
bool FrameCPP::Version_4::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!=() [3/3]
bool FrameCPP::Version_4::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/3]
Assignment operator.
- Parameters
-
[in] | dim | The object to assign from. |
- Returns
- This object.
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
- Parameters
-
[in] | dim | The object to assign from. |
- Returns
- This object.
◆ operator=() [2/3]
Assignment operator.
- Parameters
-
[in] | dim | The object to assign from. |
- Returns
- This object.
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ operator=() [3/3]
Assignment operator.
- Parameters
-
[in] | dim | The object to assign from. |
- Returns
- This object.
- Exceptions
-
std::bad_alloc | Memory allocation failed. |
◆ operator==() [1/3]
bool FrameCPP::Version_4::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/3]
bool FrameCPP::Version_4::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.
◆ operator==() [3/3]
bool FrameCPP::Version_4::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.
The documentation for this class was generated from the following files:
- /build/ldas-tools-framecpp/debian/tmp/usr/include/framecpp/Version4/Dimension.hh
- /build/ldas-tools-framecpp/obj-x86_64-linux-gnu/include/framecpp/Version4/Dimension.hh
- /build/ldas-tools-framecpp/src/Version4/Dimension.hh
- /build/ldas-tools-framecpp/src/Version4/Dimension.cc