C++ TargetRTS
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
RTTimerActor Class Reference
Inheritance diagram for RTTimerActor:
RTActor

Public Member Functions

 RTTimerActor (RTController *, RTActorRef *)
 
virtual void rtsBehavior (int, int) override
 Defines the state machine behavior for this capsule instance.
 
int anyPending (void) const
 
int numPending (void) const
 
int nextTimeout (RTTimespec &)
 
virtual int designLevel (void) const override
 
virtual const RTActor_classgetActorData (void) const override
 Get information (meta data) about the capsule, such as its name, ports, states etc.
 
void informIn (RTTimerNode *)
 
void informAt (RTTimerNode *)
 
void informAgain (RTTimerNode *)
 
void cancel (RTTimerNode *)
 
void cancelAll (Timing::Base *)
 
void adjustTimeBegin (void)
 
void adjustTimeEnd (const RTTimespec &delta, RTController *originator)
 
- Public Member Functions inherited from RTActor
 RTActor (RTController *, RTActorRef *)
 Constructor.
 
int getIndex (void) const
 Get the index of this capsule instance in its container capsule part (the capsule part where it was incarnated).
 
int index (void) const
 Get the index of this capsule instance in its container capsule part (the capsule part where it was incarnated).
 
int getId (void) const
 Get the numeric id for the capsule part that contains this capsule instance.
 
const char * getName (void) const
 Get the name of the capsule part that contains this capsule instance.
 
RTActorRefgetReference (void) const
 Get the capsule part that contains this capsule instance (the capsule part where it was incarnated).
 
const RTMessagegetMsg (void)
 Get the message which is currently being processed by the capsule instance.
 
int sendCopyToMe (const RTMessage *msg)
 Make a copy of a message and send it to this capsule instance.
 
virtual void rtsBehavior (int signal, int port)=0
 Defines the state machine behavior for this capsule instance.
 
virtual void logMsg (void)
 This function is called just before a received message is processed by the capsule instance.
 
RTControllercontext (void) const
 Get the controller which runs this capsule instance.
 
int isActive (void) const
 Determines if this capsule instance is currently active, i.e.
 
virtual int designLevel (void) const
 
const char * getTypeName (void) const
 Get the name of the capsule.
 
RTVersionId getVersion (void) const
 
int isSameType (const RTActorClass *cap) const
 Determines if the type of this capsule instance is a particular capsule type.
 
int isType (const char *str) const
 Performs a lexical comparison between the name of the capsule with a specified string.
 
virtual const RTActor_classgetActorData (void) const =0
 Get information (meta data) about the capsule, such as its name, ports, states etc.
 
int getNumStates (void) const
 Get the number of states in the capsule state machine.
 
const char * getStateString (int s) const
 Get the name of one of the states in the capsule state machine.
 
const char * getCurrentStateString (void) const
 Get the name of the currently active state in the capsule state machine.
 
int getCurrentState (void) const
 Get the numeric id of the currently active state in the capsule state machine.
 
int getHistory (int) const
 Get the numeric id of the previously active state in the capsule state machine.
 
int _numComponents (void) const
 
RTActorRef_component (int compId)
 
void _preinitialize (int _homeIndex, const RTComponentDescriptor *)
 
int initMe (const void *data, const RTObject_class *type, RTController *sender)
 
int isReferencedBy (const RTActor *) const
 
virtual const RTActorClassdefaultClass (RTActorRef &component, int repIndex)
 Get the default capsule class for a capsule part contained in the capsule instance.
 
virtual RTControllerdefaultController (RTActorRef &component, int repIndex)
 Get the default controller for a capsule part contained in the capsule instance.
 
void _incarnateAllFixed (void)
 
virtual int _followOutV (RTBindingEnd &end, int compId, int portId, int portIndex)
 
virtual int _followInV (RTBindingEnd &end, int portId, int repIndex)
 

Static Public Member Functions

static RTTimerActorsoleInstance (void)
 
static void getRelativeClock (RTTimespec &)
 

Static Public Attributes

static const RTActorClass classData
 

Protected Member Functions

void start (void)
 
void stop (void)
 
void sendTimeouts (void)
 
- Protected Member Functions inherited from RTActor
void saveHistory (void)
 
void setCurrentState (int s)
 Force the state machine of the capsule instance into a particular state.
 
virtual void unhandledMessage (void)
 This function is called when a message is dispatched to a capsule instance, but it isn't handled by its state machine.
 
virtual void unexpectedMessage (void)
 This function is called when a message is dispatched to the capsule instance, and when there is no enabled transition in the current state that can be triggered to handle the received message.
 
virtual void messageReceivedBeforeInitialized (void)
 This function is called if a message is dispatched to the capsule instance, before its initial transition has executed.
 
void unexpectedState (void)
 This function is called if the TargetRTS detects that the state machine of the capsule instance in in an invalid state (i.e.
 
void rtgChainBegin (int origin, const char *trans)
 This function is called at the beginning of every generated chain function that corresponds to a transition in the state machine.
 
void rtgTransitionBegin (void)
 This function is called just before a user-defined transition effect executes.
 
void rtgTransitionEnd (void)
 This function is called just after a user-defined transition effect has executed.
 
void enterState (int)
 
virtual void enterStateV (void)
 
virtual void rtgStateEntry (void)
 This function is called when the state machine of the capsule instance enters a new state.
 
void exitState (const RTStateId parent[])
 
virtual void exitStateV (void)
 
void processHistory (void)
 
void exitToChainState (int, const RTStateId parent[])
 
void initializeAll (void)
 
int removeImport (RTActorRef *, RTController *initiator)
 
void removeAllImports (RTController *initiator)
 
int _followIn (RTBindingEnd &end, int portId, int repIndex, RTActorRef *importer)
 
int _followOut (RTBindingEnd &end, int portId, int repIndex)
 
void _unbind (RTActorRef *importer, RTController *initiator)
 
virtual void _predestroy (void)
 
RTController::Error getError (void) const
 Get the most recent error that occurred when using the TargetRTS.
 

Protected Attributes

RTTimerList pendingAbsolute
 
RTTimerList pendingRelative
 

Static Protected Attributes

static RTTimespec currentOffset
 
static const RTActor_class rtg_class
 

Additional Inherited Members

- Public Attributes inherited from RTActor
const RTMessagemsg
 The message which is currently being processed by the capsule instance.
 
RTActorProbeprobe
 A probe attached to the capsule instance for monitoring it.
 

Member Function Documentation

◆ designLevel()

virtual int RTTimerActor::designLevel ( void  ) const
overridevirtual

Reimplemented from RTActor.

◆ getActorData()

virtual const RTActor_class * RTTimerActor::getActorData ( void  ) const
overridevirtual

Get information (meta data) about the capsule, such as its name, ports, states etc.

This information is static and comes from the definition of the capsule.

Returns
Information about the capsule.

Implements RTActor.

◆ rtsBehavior()

virtual void RTTimerActor::rtsBehavior ( int  signal,
int  port 
)
overridevirtual

Defines the state machine behavior for this capsule instance.

This function is implemented in each concrete capsule subclass.

Parameters
[in]signalThe event of the currently processed message.
[in]portThe port on which the currently processed message arrived.

Implements RTActor.


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