Class ae108::cpppetsc::SharedEntity

template <typename T, typename Policy>

ClassList > ae108 > cpppetsc > SharedEntity

Public Types

Type	Name
typedef PetscInt	size_type

Public Functions

Type	Name
	SharedEntity (T t) Takes ownership of t without increasing the reference count.
	SharedEntity (const SharedEntity & in) Creates a shallow copy of the entity by increasing the reference count.
	SharedEntity (SharedEntity &&) noexcept Takes ownership without increasing the reference count.
size_type	count () const Returns the reference count of the entity.
T	get () noexcept const Returns the entity.
	operator bool () noexcept const Returns true if and only if the contained entity is not the nullptr.
SharedEntity &	operator= (const SharedEntity & in) Creates a shallow copy of the entity by increasing the reference count.
SharedEntity &	operator= (SharedEntity &&) noexcept Takes ownership without increasing the reference count.
	~SharedEntity () = default

Public Types Documentation

typedef size_type

using ae108::cpppetsc::SharedEntity< T, Policy >::size_type =  PetscInt;

---

Public Functions Documentation

function SharedEntity [1/3]

Takes ownership of t without increasing the reference count.

explicit ae108::cpppetsc::SharedEntity::SharedEntity (
    T t
) 

---

function SharedEntity [2/3]

Creates a shallow copy of the entity by increasing the reference count.

ae108::cpppetsc::SharedEntity::SharedEntity (
    const SharedEntity & in
) 

---

function SharedEntity [3/3]

Takes ownership without increasing the reference count.

ae108::cpppetsc::SharedEntity::SharedEntity (
    SharedEntity &&
) noexcept

---

function count

Returns the reference count of the entity.

size_type ae108::cpppetsc::SharedEntity::count () const

---

function get

Returns the entity.

T ae108::cpppetsc::SharedEntity::get () noexcept const

---

function operator bool

Returns true if and only if the contained entity is not the nullptr.

explicit ae108::cpppetsc::SharedEntity::operator bool () noexcept const

---

function operator=

Creates a shallow copy of the entity by increasing the reference count.

SharedEntity & ae108::cpppetsc::SharedEntity::operator= (
    const SharedEntity & in
) 

---

function operator=

Takes ownership without increasing the reference count.

SharedEntity & ae108::cpppetsc::SharedEntity::operator= (
    SharedEntity &&
) noexcept

---

function ~SharedEntity

ae108::cpppetsc::SharedEntity::~SharedEntity () = default

---

---

The documentation for this class was generated from the following file cpppetsc/src/include/ae108/cpppetsc/SharedEntity.h