ceps::HoldsBoundary Class Reference

Detailed Description

Abstract class to describe if an entity is on a boundary or not Objects that can be located in a mesh should inherit from this class.

Definition at line 41 of file HoldsBoundary.hpp.

#include <HoldsBoundary.hpp>

Inheritance diagram for ceps::HoldsBoundary:

Public Member Functions
	HoldsBoundary (const CepsBool &isBoundary)
	Constructor with given information. More...
	HoldsBoundary ()=default
	Default constructor. More...
	HoldsBoundary (const HoldsBoundary &)=default
	Copy constructor. More...
	HoldsBoundary (HoldsBoundary &&) noexcept=default
	Copy constructor. More...
virtual	~HoldsBoundary ()=default
	Destructor. More...
HoldsBoundary &	operator= (const HoldsBoundary &)=default
	Assignment operator. More...
HoldsBoundary &	operator= (HoldsBoundary &&) noexcept=default
	Assignment operator. More...
CepsBool	isBoundary () const
	Tells if entity is on boundary or not. More...
void	setOnBoundary (CepsBool value=true)
	Sets the entity as being on boundary or not. More...
void	reset ()
	Sets the entity as NOT being on boundary. More...

Private Attributes
CepsBool	m_isBoundary
	Tells if entity is on boundary. More...

Constructor & Destructor Documentation

HoldsBoundary() [1/4]

ceps::HoldsBoundary::HoldsBoundary ( const CepsBool &  isBoundary )

explicit

Constructor with given information.

Definition at line 32 of file HoldsBoundary.cpp.

HoldsBoundary() [2/4]

ceps::HoldsBoundary::HoldsBoundary ( )

default

Default constructor.

HoldsBoundary() [3/4]

ceps::HoldsBoundary::HoldsBoundary ( const HoldsBoundary &  )

default

Copy constructor.

HoldsBoundary() [4/4]

ceps::HoldsBoundary::HoldsBoundary ( HoldsBoundary &&  )

defaultnoexcept

Copy constructor.

~HoldsBoundary()

virtual ceps::HoldsBoundary::~HoldsBoundary ( )

virtualdefault

Destructor.

Member Function Documentation

isBoundary()

CepsBool ceps::HoldsBoundary::isBoundary

(

)

const

Tells if entity is on boundary or not.

Definition at line 37 of file HoldsBoundary.cpp.

operator=() [1/2]

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

default

Assignment operator.

operator=() [2/2]

HoldsBoundary& ceps::HoldsBoundary::operator= ( HoldsBoundary &&  )

defaultnoexcept

Assignment operator.

reset()

void ceps::HoldsBoundary::reset

(

)

Sets the entity as NOT being on boundary.

Definition at line 50 of file HoldsBoundary.cpp.

setOnBoundary()

void ceps::HoldsBoundary::setOnBoundary

(

CepsBool

value = true

)

Sets the entity as being on boundary or not.

Definition at line 43 of file HoldsBoundary.cpp.

Field Documentation

m_isBoundary

CepsBool ceps::HoldsBoundary::m_isBoundary

private

Tells if entity is on boundary.

Definition at line 85 of file HoldsBoundary.hpp.

---

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

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