A type descriptor providing information about the external characteristics of a capsule. More...

#include <RTActorClass.h>

Public Member Functions
int	isKindOf (const RTActorClass *other) const
	Determines if the described capsule is the same, or a subtype of, another capsule.

int	substitutableFor (const RTComponentDescriptor *cp) const
	Determines if the described capsule is compatible with a certain capsule part.

Public Attributes
const RTActorClass *	super
	Type descriptor for the super capsule, from which the described capsule inherits.

const char *	name
	Capsule name.

RTVersionId	version
	The version id of the capsule.

int	numRelays
	The number of service ports (i.e.

const RTRelayDescriptor *	relays
	An array of objects describing the service ports of the capsule (i.e.

RTActorCreator	create
	Constructor function for creating an instance of (i.e.

Detailed Description

A type descriptor providing information about the external characteristics of a capsule.

A static variable of this struct will be automatically generated for each capsule in the application. The most common use for a capsule type descriptor is with the Frame service; see for example Frame::base::incarnate(). Type descriptors for other types are implemented by means of the RTObject_class struct.

Member Function Documentation

◆ isKindOf()

int RTActorClass::isKindOf ( const RTActorClass * other ) const

Determines if the described capsule is the same, or a subtype of, another capsule.

Parameters

other Type descriptor for the other capsule to check the described capsule against.

Returns: 1 if yes, 0 if no.

◆ substitutableFor()

int RTActorClass::substitutableFor ( const RTComponentDescriptor * cp ) const

Determines if the described capsule is compatible with a certain capsule part.

For an optional or plugin capsule part the actual type of a capsule instance that is added to the capsule part may or may not be exactly the same as the type of the capsule part. A capsule part has a property "Substitutable Type" and if it's true, then the type of a capsule instance only has to be compatible with the type of the capsule part. If instead the property is false, then the type of the instance has to match the type of the capsule part exactly.

Parameters

cp	Object describing a capsule part.

Returns: 1 if yes, 0 if no.

Member Data Documentation

◆ create

RTActorCreator RTActorClass::create

Constructor function for creating an instance of (i.e.

incarnating) the capsule.

◆ numRelays

int RTActorClass::numRelays

The number of service ports (i.e.

the externally visible relay ports that constitute the communication interface of the capsule).

◆ relays

const RTRelayDescriptor* RTActorClass::relays

An array of objects describing the service ports of the capsule (i.e.