ceps::HoldsGlobalIndex Class Reference

Detailed Description

Abstract class for objects that have a global index.

Definition at line 41 of file HoldsGlobalIndex.hpp.

#include <HoldsGlobalIndex.hpp>

Inheritance diagram for ceps::HoldsGlobalIndex:

Public Member Functions
	HoldsGlobalIndex (const CepsGlobalIndex &gid)
	Constructor with ID. More...
	HoldsGlobalIndex ()=default
	Default constructor. More...
	HoldsGlobalIndex (const HoldsGlobalIndex &)=default
	Copy constructor. More...
	HoldsGlobalIndex (HoldsGlobalIndex &&) noexcept=default
	Copy constructor. More...
virtual	~HoldsGlobalIndex ()=default
	Destructor. More...
HoldsGlobalIndex &	operator= (const HoldsGlobalIndex &)=default
	Assignment operator. More...
HoldsGlobalIndex &	operator= (HoldsGlobalIndex &&) noexcept=default
	Assignment operator. More...
const CepsGlobalIndex &	getGlobalIndex () const
	Get the index More...
void	setGlobalIndex (const CepsGlobalIndex &gid)
	Set the index. More...
void	reset ()
	Set the index to 0u. More...

Protected Attributes
CepsGlobalIndex	m_globalIndex
	the index More...

Constructor & Destructor Documentation

HoldsGlobalIndex() [1/4]

ceps::HoldsGlobalIndex::HoldsGlobalIndex ( const CepsGlobalIndex &  gid )

explicit

Constructor with ID.

Definition at line 33 of file HoldsGlobalIndex.cpp.

HoldsGlobalIndex() [2/4]

ceps::HoldsGlobalIndex::HoldsGlobalIndex ( )

default

Default constructor.

HoldsGlobalIndex() [3/4]

ceps::HoldsGlobalIndex::HoldsGlobalIndex ( const HoldsGlobalIndex &  )

default

Copy constructor.

HoldsGlobalIndex() [4/4]

ceps::HoldsGlobalIndex::HoldsGlobalIndex ( HoldsGlobalIndex &&  )

defaultnoexcept

Copy constructor.

~HoldsGlobalIndex()

virtual ceps::HoldsGlobalIndex::~HoldsGlobalIndex ( )

virtualdefault

Destructor.

Member Function Documentation

getGlobalIndex()

const CepsGlobalIndex & ceps::HoldsGlobalIndex::getGlobalIndex

(

)

const

Get the index

Definition at line 39 of file HoldsGlobalIndex.cpp.

operator=() [1/2]

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

default

Assignment operator.

operator=() [2/2]

HoldsGlobalIndex& ceps::HoldsGlobalIndex::operator= ( HoldsGlobalIndex &&  )

defaultnoexcept

Assignment operator.

reset()

void ceps::HoldsGlobalIndex::reset

(

)

Set the index to 0u.

Definition at line 52 of file HoldsGlobalIndex.cpp.

setGlobalIndex()

void ceps::HoldsGlobalIndex::setGlobalIndex

(

const CepsGlobalIndex &

gid

)

Set the index.

Definition at line 45 of file HoldsGlobalIndex.cpp.

Field Documentation

m_globalIndex

CepsGlobalIndex ceps::HoldsGlobalIndex::m_globalIndex

protected

the index

Definition at line 85 of file HoldsGlobalIndex.hpp.

---

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

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