Object Class Reference

Object with value semantics More...

#include <cc/Object>

Inheritance diagram for Object:

Classes
class	State
	Reference counted object state. More...

Public Types
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
	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 Member Functions
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 T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)

Protected Attributes
Handle< State >	me
	Internal object state

Detailed Description

Object with value semantics

Member Typedef Documentation

NullAccess

using NullAccess = cc::NullAccess

Error thrown when trying to access a null object.

VirginityTestFailed

using VirginityTestFailed = cc::VirginityTestFailed

Error thrown when trying to initialize an object with a non-virgin state.

Constructor & Destructor Documentation

Object() [1/2]

Object ( )

default

Create a null object.

Object() [2/2]

Object ( State * newState )

explicitprotected

Initialize object with newState.

Member Function Documentation

operator bool()

operator bool ( ) const

explicit

Check if this is a non-null object.

isNull()

bool isNull

(

)

const

Check if this is a null object.

useCount()

int useCount

(

)

const

Reference count.

is()

template<class T>

bool is

(

)

const

Check if this object is of type T.

as()

template<class T>

T as

(

)

const

Cast this object to type T.

isWeak()

bool isWeak

(

)

const

Check if the underlying object reference is weak.

operator==()

bool operator==

(

const Object &

other

)

const

Equality operator.

operator<=>()

std::strong_ordering operator<=>

(

const Object &

other

)

const

Ordering operator.

alias()

template<class T>

T alias ( const State * state )

staticprotected

Create an alias object for the given state.

Template Parameters

T	Type of object

initOnce()

template<class T>

void initOnce ( )

protected

Create the object state when called the first time.

Template Parameters

T	Type of object state

initOncePerThread()

template<class T>

void initOncePerThread ( )

protected

Create a distinct object state for each thread when called the first time in that thread.

Template Parameters

T	Type of object state

Member Data Documentation

me

Handle<State> me

mutableprotected

Internal object state