C++ TargetRTS
Loading...
Searching...
No Matches
Public Member Functions | List of all members
RTDefaultActorFactory_NoCreate Class Reference

A capsule factory with a default destroy implementation, but without a create implementation (the create function will return nullptr). More...

#include <RTDefaultActorFactory.h>

Inheritance diagram for RTDefaultActorFactory_NoCreate:
RTActorFactoryInterface

Public Member Functions

RTActorcreate (RTController *rts, RTActorRef *ref, int index) override
 Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part.
 
void destroy (RTActor *actor) override
 Called by the TargetRTS to destroy a capsule instance.
 
virtual RTActorcreate (RTController *rts, RTActorRef *ref, int index)=0
 Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part.
 
virtual void destroy (RTActor *actor)=0
 Called by the TargetRTS to destroy a capsule instance.
 

Detailed Description

A capsule factory with a default destroy implementation, but without a create implementation (the create function will return nullptr).

In generated code this class is used as base class for a custom capsule factory for a capsule part where the type of the capsule part is a capsule without a default capsule constructor.

Member Function Documentation

◆ create()

RTActor * RTDefaultActorFactory_NoCreate::create ( RTController rts,
RTActorRef ref,
int  index 
)
inlineoverridevirtual

Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part.

Parameters
[in]rtsThe controller that would run the new capsule instance by default
[in]refThe capsule part where the created instance will later be inserted
[in]indexThe index within the capsule part where the instance will later be inserted
Returns
The created capsule instance, ready to be inserted into the capsule part. If nullptr is returned the TargetRTS will use the capsule's RTActorCreator for creating the instance.

Implements RTActorFactoryInterface.

◆ destroy()

void RTDefaultActorFactory_NoCreate::destroy ( RTActor actor)
inlineoverridevirtual

Called by the TargetRTS to destroy a capsule instance.

Parameters
[in]actorCapsule instance to be destroyed

Implements RTActorFactoryInterface.


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