FrameCPP::Version_4::Dimension Class Reference

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. More...
	Dimension (const Dimension &dim)
	Copy constructor. More...
	Dimension (const Previous::Dimension &dim)
	exc: std::bad_alloc - Memory allocation failed. 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
	exc: None. More...
dx_type	GetDx () const
	exc: None. More...
startX_type	GetStartX () const
	exc: None. More...
const STRING &	GetUnitX () const
	exc: None. More...
void	SetNx (nx_type Nx)
cmn_streamsize_type	Bytes () const
	Dimension ()
	exc: None. More...
	Dimension (const Dimension &dim)
	Copy constructor. More...
	Dimension (const Previous::Dimension &dim)
	exc: std::bad_alloc - Memory allocation failed. 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
	exc: None. More...
dx_type	GetDx () const
	exc: None. More...
startX_type	GetStartX () const
	exc: None. More...
const STRING &	GetUnitX () const
	exc: None. More...
void	SetNx (nx_type Nx)
cmn_streamsize_type	Bytes () const

Private Attributes
nx_type	mNx
	Dimension length. More...
dx_type	mDx
	Scale factor. More...
STRING	mUnitX
	Scale factor in ASCII. More...
startX_type	mStartX
	Origin. More...

Detailed Description

Dimension information for a Vect.

This is a simple class storing dimension information for a Vect object. It stores the following:

1. The dimension length.
2. Scale factor
3. The units (unit per step size along the coordintate).

Member Typedef Documentation

dx_type [1/2]

typedef REAL_8 FrameCPP::Version_4::Dimension::dx_type

dx_type [2/2]

typedef REAL_8 FrameCPP::Version_4::Dimension::dx_type

nx_type [1/2]

typedef INT_4U FrameCPP::Version_4::Dimension::nx_type

nx_type [2/2]

typedef INT_4U FrameCPP::Version_4::Dimension::nx_type

startX_type [1/2]

typedef REAL_8 FrameCPP::Version_4::Dimension::startX_type

startX_type [2/2]

typedef REAL_8 FrameCPP::Version_4::Dimension::startX_type

Constructor & Destructor Documentation

Dimension() [1/8]

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/8]

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/8]

FrameCPP::Version_4::Dimension::Dimension ( const Previous::Dimension &  dim )

inline

exc: std::bad_alloc - Memory allocation failed.

Dimension() [4/8]

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() [5/8]

FrameCPP::Version_4::Dimension::Dimension

(

)

exc: None.

Dimension() [6/8]

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/8]

FrameCPP::Version_4::Dimension::Dimension

(

const Previous::Dimension &

dim

)

exc: std::bad_alloc - Memory allocation failed.

Dimension() [8/8]

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.

Member Function Documentation

Bytes() [1/2]

cmn_streamsize_type FrameCPP::Version_4::Dimension::Bytes ( ) const

inline

Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_4::Dimension::Bytes

(

)

const

GetDx() [1/2]

Dimension::dx_type FrameCPP::Version_4::Dimension::GetDx ( ) const

inline

exc: None.

Get the scale factor.

Returns

The scale factor.

GetDx() [2/2]

dx_type FrameCPP::Version_4::Dimension::GetDx

(

)

const

exc: None.

GetNx() [1/2]

Dimension::nx_type FrameCPP::Version_4::Dimension::GetNx ( ) const

inline

exc: None.

Get the dimension length.

Returns

The dimension length.

GetNx() [2/2]

nx_type FrameCPP::Version_4::Dimension::GetNx

(

)

const

exc: None.

GetStartX() [1/2]

Dimension::startX_type FrameCPP::Version_4::Dimension::GetStartX ( ) const

inline

exc: None.

Get data set origin.

Returns

Data set origin.

GetStartX() [2/2]

startX_type FrameCPP::Version_4::Dimension::GetStartX

(

)

const

exc: None.

GetUnitX() [1/2]

const STRING& FrameCPP::Version_4::Dimension::GetUnitX

(

)

const

exc: None.

GetUnitX() [2/2]

const STRING & FrameCPP::Version_4::Dimension::GetUnitX ( ) const

inline

exc: None.

Get the units.

Returns

The units.

operator!=() [1/2]

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/2]

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/2]

const Dimension& FrameCPP::Version_4::Dimension::operator=

(

const Dimension &

dim

)

Assignment operator.

Parameters

[in]

dim

The object to assign from.

Returns

This object.

Exceptions

std::bad_alloc

Memory allocation failed.

operator=() [2/2]

const Dimension & FrameCPP::Version_4::Dimension::operator= ( const Dimension &  dim )

inline

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==() [1/2]

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==() [2/2]

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.

SetNx() [1/2]

void FrameCPP::Version_4::Dimension::SetNx

(

nx_type

Nx

)

SetNx() [2/2]

void FrameCPP::Version_4::Dimension::SetNx ( nx_type  Nx )

inline

Member Data Documentation

mDx

dx_type FrameCPP::Version_4::Dimension::mDx

private

Scale factor.

mNx

nx_type FrameCPP::Version_4::Dimension::mNx

private

Dimension length.

mStartX

startX_type FrameCPP::Version_4::Dimension::mStartX

private

Origin.

mUnitX

STRING FrameCPP::Version_4::Dimension::mUnitX

private

Scale factor in ASCII.

---

The documentation for this class was generated from the following files:

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version4/Dimension.hh
• Version4/Dimension.cc