Entity Class Reference

Objects that materialize on-demand. More...

#include <cc/Entity>

Inheritance diagram for Entity:

Protected Types
using	State = Object::State
	Internal state.
using	Constructor = State *()
	Internal state constructor.

Protected Member Functions
	Entity (State *newState)
	Initialize entity with newState.
	Entity (Constructor onDemand)
	Initialize a primordial entity.
template<class T>
T &	get ()
	Get access to the entity's internal state of type T.
template<class T>
const T &	get () const
	Get access to the entity's internal state.
Protected Member Functions inherited from Object
template<class T>
T	weak () const
template<class T>
void	initOnce ()
	Create the object state when called the first time.
template<class T>
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)

Static Protected Member Functions
template<class T>
static State *	onDemand ()
	Convenience template for initializing primordial entities.
Static Protected Member Functions inherited from Object
template<class T>
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)

Additional Inherited Members
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Objects that materialize on-demand.

Member Typedef Documentation

State

using State = Object::State

protected

Internal state.

Constructor

using Constructor = State *()

protected

Internal state constructor.

Constructor & Destructor Documentation

Entity() [1/2]

Entity ( State * newState )

explicitprotected

Initialize entity with newState.

Entity() [2/2]

Entity ( Constructor onDemand )

explicitprotected

Initialize a primordial entity.

Member Function Documentation

onDemand()

template<class T>

State * onDemand ( )

staticprotected

Convenience template for initializing primordial entities.

get() [1/2]

template<class T>

T & get ( )

protected

Get access to the entity's internal state of type T.

get() [2/2]

template<class T>

const T & get ( ) const

protected

Get access to the entity's internal state.