FrameCPP::Version_3::Dimension Class Reference

Dimension information for a Vect. More...

#include <Dimension.hh>

Collaboration diagram for FrameCPP::Version_3::Dimension:

Public Types
typedef INT_4U	nx_type
typedef REAL_8	dx_type
typedef INT_4U	nx_type
typedef REAL_8	dx_type

Public Member Functions
	Dimension ()
	Default Constructor.
	Dimension (const Dimension &dim)
	Copy constructor.
	Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="")
	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.
const STRING &	GetUnitX () const
	Get the units.
void	SetDx (dx_type Dx)
	Set sample spacing.
void	SetNx (nx_type Nx)
void	SetUnitX (const STRING &UnitX)
	Set scale factor in ASCII.
cmn_streamsize_type	Bytes () const
	Dimension ()
	Dimension (const Dimension &dim)
	Dimension (nx_type nx, dx_type dx=1.0, const std::string &unitX="")
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
dx_type	GetDx () const
const STRING &	GetUnitX () const
void	SetDx (dx_type Dx)
	Set sample spacing.
void	SetNx (nx_type Nx)
void	SetUnitX (const STRING &UnitX)
	Set scale factor in ASCII.
cmn_streamsize_type	Bytes () const

Private Attributes
nx_type	mNx
	Dimension length.
dx_type	mDx
	Scale factor.
STRING	mUnitX
	Scale factor in ASCII.

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_3::Dimension::dx_type

dx_type [2/2]

typedef REAL_8 FrameCPP::Version_3::Dimension::dx_type

nx_type [1/2]

typedef INT_4U FrameCPP::Version_3::Dimension::nx_type

nx_type [2/2]

typedef INT_4U FrameCPP::Version_3::Dimension::nx_type

Constructor & Destructor Documentation

Dimension() [1/6]

FrameCPP::Version_3::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/6]

FrameCPP::Version_3::Dimension::Dimension

(

const Dimension &

dim

)

Copy constructor.

Exceptions

std::bad_alloc

Memory allocation failed.

Parameters

[ion]

dim - The Dimension to copy from.

\excpetion std::bad_alloc Memory allocation failed.

Dimension() [3/6]

FrameCPP::Version_3::Dimension::Dimension ( nx_type nx, dx_type dx = 1.0, const std::string & unitX = "" )

explicit

Constructor.

\excpetion std::bad_alloc Memory allocation failed.

This creates a Dimension object with the specified attributes.

Parameters

[in]	nx	The dimension length.
[in]	dx	The Scale Factor. Default: 1.0
[in]	unitX	The units (unit per step size).

Exceptions

std::bad_alloc

Memory allocation failed.

Dimension() [4/6]

FrameCPP::Version_3::Dimension::Dimension

(

)

Dimension() [5/6]

FrameCPP::Version_3::Dimension::Dimension

(

const Dimension &

dim

)

Exceptions

std::bad_alloc

Memory allocation failed.

Dimension() [6/6]

FrameCPP::Version_3::Dimension::Dimension ( nx_type nx, dx_type dx = 1.0, const std::string & unitX = "" )

explicit

\excpetion std::bad_alloc Memory allocation failed.

Member Function Documentation

Bytes() [1/2]

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

inline

Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_3::Dimension::Bytes

(

)

const

GetDx() [1/2]

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

inline

Get the scale factor.

Returns

The scale factor.

GetDx() [2/2]

dx_type FrameCPP::Version_3::Dimension::GetDx

(

)

const

GetNx() [1/2]

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

inline

Get the dimension length.

Returns

The dimension length.

GetNx() [2/2]

nx_type FrameCPP::Version_3::Dimension::GetNx

(

)

const

GetUnitX() [1/2]

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

inline

Get the units.

Returns

The units.

GetUnitX() [2/2]

const STRING & FrameCPP::Version_3::Dimension::GetUnitX

(

)

const

operator!=() [1/2]

bool FrameCPP::Version_3::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.

Parameters

[in]

dim

The object to compare with.

Returns

false if the objects are equal, true otherwise.

operator!=() [2/2]

bool FrameCPP::Version_3::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_3::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.

operator=() [2/2]

const Dimension & FrameCPP::Version_3::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==() [1/2]

bool FrameCPP::Version_3::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.

Parameters

[in]

dim

The object to compare with.

Returns

true if the objects are equal, false otherwise.

operator==() [2/2]

bool FrameCPP::Version_3::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_3::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_3::Dimension::SetDx

(

dx_type

Dx

)

Set sample spacing.

Parameters

[in]

Dx

The new sample rate for the coordinate.

SetNx() [1/2]

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

inline

SetNx() [2/2]

void FrameCPP::Version_3::Dimension::SetNx

(

nx_type

Nx

)

SetUnitX() [1/2]

void FrameCPP::Version_3::Dimension::SetUnitX ( const STRING & 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_3::Dimension::SetUnitX

(

const STRING &

UnitX

)

Set scale factor in ASCII.

Parameters

[in]

UnitX

The new scale factor description.

Member Data Documentation

mDx

dx_type FrameCPP::Version_3::Dimension::mDx

private

Scale factor.

mNx

nx_type FrameCPP::Version_3::Dimension::mNx

private

Dimension length.

mUnitX

STRING FrameCPP::Version_3::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-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version3/Dimension.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/Dimension.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/Dimension.cc