An object that identifies a capsule instance at run-time. More...

#include <RTActorId.h>

Inheritance diagram for RTActorId:

Public Member Functions
	RTActorId (const RTActor *=nullptr)
	Construction from an RTActor pointer.

	RTActorId (const RTActorId &)
	Construction from an RTActor reference.

	operator RTActor * (void) const

RTActorId &	operator= (const RTActor *)

RTActorId &	operator= (const RTActorId &)

RTActor *	operator-> (void) const

virtual int	operator== (const RTDataObject &) const override

int	operator== (const RTActorRef &) const

int	operator== (const RTActorId &) const

int	operator!= (const RTDataObject &) const

int	operator!= (const RTActorRef &) const

int	operator!= (const RTActorId &) const

int	isValid (void) const
	Determine if this object identifies a valid capsule instance.

RTActor *	getRTActor (void) const
	Return the wrapped RTActor pointer.

void	resetActor (void)
	Reset the capsule instance identifier.

virtual const RTObject_class *	getClassData (void) const override
	Return the type descriptor for the RTActor object.

Public Member Functions inherited from RTDataObject
	RTDataObject (const RTDataObject &)

virtual int	operator== (const RTDataObject &) const

int	operator!= (const RTDataObject &) const

virtual RTDataObject *	copy (void) const

char *	printString (void) const

int	printString (char *buf, int size) const

virtual int	put (RTEncoding &) const

virtual int	ObjectForm (RTDecoding &)

virtual const RTObject_class *	getClassData (void) const

virtual const char *	getTypeName (void) const

RTVersionId	getVersion (void) const

int	isType (const char *) const

int	isSameType (const RTObject_class *) const

Static Public Attributes
static const RTObject_class	classData
	Type descriptor for the RTActor object.

Static Public Attributes inherited from RTDataObject
static const RTObject_class	classData

Additional Inherited Members
Static Public Member Functions inherited from RTDataObject
static void	initialize (void)

Detailed Description

An object that identifies a capsule instance at run-time.

It is a wrapper object for an RTActor pointer.

Member Function Documentation

◆ getClassData()

virtual const RTObject_class * RTActorId::getClassData ( void ) const

overridevirtual

Return the type descriptor for the RTActor object.

Returns: Type descriptor which allows an RTActor object to be encoded, decoded, copied etc.

Reimplemented from RTDataObject.

◆ getRTActor()

RTActor * RTActorId::getRTActor ( void ) const

Return the wrapped RTActor pointer.

Returns: The wrapped RTActor pointer.

◆ isValid()

int RTActorId::isValid ( void ) const

Determine if this object identifies a valid capsule instance.

This function should be called immediately after incarnating a capsule instance to check if the incarnation was successful. Note that after destroying a capsule instance this function still returns 1 even if the wrapped RTActor pointer then is invalid. Make sure to call resetActor() for an RTActorId object that identifies a capsule instance that is destroyed.

Returns: 1 if the capsule instance is valid (incarnation was successful), 0 otherwise.

◆ operator==()

virtual int RTActorId::operator== ( const RTDataObject & ) const

overridevirtual

Reimplemented from RTDataObject.

◆ resetActor()

void RTActorId::resetActor ( void )

Reset the capsule instance identifier.

This function should be called if the capsule instance is destroyed.

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

RTActorId.h
RTActorId.inl

Public Member Functions

Static Public Attributes