ceps::HoldsDimension Class Reference

Detailed Description

Abstract class for objects that have a dimensionality (0D to 3D)

Definition at line 41 of file HoldsDimension.hpp.

#include <HoldsDimension.hpp>

Inheritance diagram for ceps::HoldsDimension:

Public Member Functions
	HoldsDimension (const CepsUInt &dim)
	Constructor with dimension. More...
	HoldsDimension ()=default
	Default constructor. More...
	HoldsDimension (const HoldsDimension &)=default
	Constructor by copy. More...
	HoldsDimension (HoldsDimension &&) noexcept=default
	Constructor by copy. More...
virtual	~HoldsDimension ()=default
	Destructor. More...
HoldsDimension &	operator= (const HoldsDimension &)=default
	Assignment operator. More...
HoldsDimension &	operator= (HoldsDimension &&) noexcept=default
	Assignment operator. More...
const CepsUInt &	getDimension () const
	Get the dimension of the object. More...
void	setDimension (const CepsUInt &dim)
	Set the dimension of the object. More...
void	reset ()
	Set the dimension of the object to 0. More...

Private Attributes
CepsUInt	m_dimension
	The dimension. More...

Constructor & Destructor Documentation

HoldsDimension() [1/4]

ceps::HoldsDimension::HoldsDimension ( const CepsUInt &  dim )

explicit

Constructor with dimension.

Definition at line 33 of file HoldsDimension.cpp.

HoldsDimension() [2/4]

ceps::HoldsDimension::HoldsDimension ( )

default

Default constructor.

HoldsDimension() [3/4]

ceps::HoldsDimension::HoldsDimension ( const HoldsDimension &  )

default

Constructor by copy.

HoldsDimension() [4/4]

ceps::HoldsDimension::HoldsDimension ( HoldsDimension &&  )

defaultnoexcept

Constructor by copy.

~HoldsDimension()

virtual ceps::HoldsDimension::~HoldsDimension ( )

virtualdefault

Destructor.

Member Function Documentation

getDimension()

const CepsUInt & ceps::HoldsDimension::getDimension

(

)

const

Get the dimension of the object.

Definition at line 39 of file HoldsDimension.cpp.

operator=() [1/2]

HoldsDimension& ceps::HoldsDimension::operator= ( const HoldsDimension &  )

default

Assignment operator.

operator=() [2/2]

HoldsDimension& ceps::HoldsDimension::operator= ( HoldsDimension &&  )

defaultnoexcept

Assignment operator.

reset()

void ceps::HoldsDimension::reset

(

)

Set the dimension of the object to 0.

Definition at line 52 of file HoldsDimension.cpp.

setDimension()

void ceps::HoldsDimension::setDimension

(

const CepsUInt &

dim

)

Set the dimension of the object.

Definition at line 45 of file HoldsDimension.cpp.

Field Documentation

m_dimension

CepsUInt ceps::HoldsDimension::m_dimension

private

The dimension.

Definition at line 85 of file HoldsDimension.hpp.

---

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

• /builds/xxjFYZX3/0/carmen/ceps/src/common/abstract/HoldsDimension.hpp
• /builds/xxjFYZX3/0/carmen/ceps/src/common/abstract/HoldsDimension.cpp