CEPS  24.01
Cardiac ElectroPhysiology Simulator
ceps::HoldsGeomObject< _GeomObject > Class Template Reference

Detailed Description

template<class _GeomObject>
class ceps::HoldsGeomObject< _GeomObject >

For objects that have pointers to either a node or a cell.

Definition at line 40 of file HoldsGeomObject.hpp.

#include <HoldsGeomObject.hpp>

Public Member Functions

 HoldsGeomObject (_GeomObject *object=nullptr, CepsBool owned=false)
 Constructor with ID. More...
 
 HoldsGeomObject (const HoldsGeomObject &)=default
 Copy constructor. More...
 
 HoldsGeomObject (HoldsGeomObject &&) noexcept=default
 Copy constructor. More...
 
virtual ~HoldsGeomObject ()
 Destructor. More...
 
HoldsGeomObjectoperator= (const HoldsGeomObject &)=default
 Assignment operator. More...
 
HoldsGeomObjectoperator= (HoldsGeomObject &&) noexcept=default
 Assignment operator. More...
 
_GeomObject * getGeomObject () const
 Get the geom object. More...
 
_GeomObject * getProperties () const
 Get the properties (in fact it's just the geom object) More...
 
virtual void setGeomObject (_GeomObject *object, CepsBool owned)
 Set the geom object. More...
 
void reset ()
 Set the geom object pointer to nullptr. More...
 

Protected Attributes

CepsBool m_owned
 Is the geom object owned by current CPU. More...
 
_GeomObject * m_gObject
 Ptr to the object. More...
 

Constructor & Destructor Documentation

◆ HoldsGeomObject() [1/3]

template<class _GeomObject >
ceps::HoldsGeomObject< _GeomObject >::HoldsGeomObject ( _GeomObject *  object = nullptr,
CepsBool  owned = false 
)
explicit

Constructor with ID.

◆ HoldsGeomObject() [2/3]

template<class _GeomObject >
ceps::HoldsGeomObject< _GeomObject >::HoldsGeomObject ( const HoldsGeomObject< _GeomObject > &  )
default

Copy constructor.

◆ HoldsGeomObject() [3/3]

template<class _GeomObject >
ceps::HoldsGeomObject< _GeomObject >::HoldsGeomObject ( HoldsGeomObject< _GeomObject > &&  )
defaultnoexcept

Copy constructor.

◆ ~HoldsGeomObject()

template<class _GeomObject >
virtual ceps::HoldsGeomObject< _GeomObject >::~HoldsGeomObject ( )
virtual

Destructor.

Member Function Documentation

◆ getGeomObject()

template<class _GeomObject >
_GeomObject* ceps::HoldsGeomObject< _GeomObject >::getGeomObject ( ) const

Get the geom object.

◆ getProperties()

template<class _GeomObject >
_GeomObject* ceps::HoldsGeomObject< _GeomObject >::getProperties ( ) const

Get the properties (in fact it's just the geom object)

◆ operator=() [1/2]

template<class _GeomObject >
HoldsGeomObject& ceps::HoldsGeomObject< _GeomObject >::operator= ( const HoldsGeomObject< _GeomObject > &  )
default

Assignment operator.

◆ operator=() [2/2]

template<class _GeomObject >
HoldsGeomObject& ceps::HoldsGeomObject< _GeomObject >::operator= ( HoldsGeomObject< _GeomObject > &&  )
defaultnoexcept

Assignment operator.

◆ reset()

template<class _GeomObject >
void ceps::HoldsGeomObject< _GeomObject >::reset ( )

Set the geom object pointer to nullptr.

◆ setGeomObject()

template<class _GeomObject >
virtual void ceps::HoldsGeomObject< _GeomObject >::setGeomObject ( _GeomObject *  object,
CepsBool  owned 
)
virtual

Set the geom object.

Reimplemented in FENode, and FEBase.

Field Documentation

◆ m_gObject

template<class _GeomObject >
_GeomObject* ceps::HoldsGeomObject< _GeomObject >::m_gObject
protected

Ptr to the object.

Definition at line 84 of file HoldsGeomObject.hpp.

◆ m_owned

template<class _GeomObject >
CepsBool ceps::HoldsGeomObject< _GeomObject >::m_owned
protected

Is the geom object owned by current CPU.

Definition at line 83 of file HoldsGeomObject.hpp.


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