Class SBSSimulatorEvent#

This class describes a simulator event. More...

#include <SBSSimulatorEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type	Name
enum	Type The type of the simulator event.

Public Types inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
enum	Category The category of the data graph event.

Public Functions#

Type	Name
	SBSSimulatorEvent (SBSSimulator * sender, Type type) Builds a simulator event.
virtual Category	getCategory () override const Returns the category of the event.
SBSSimulator *	getSender () const Returns the sender of the event.
Type	getType () const Returns the simulator event type.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual	~SBSSimulatorEvent () Destructor.

Public Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphNode * sender) Build a data graph event for the sender `sender` .
virtual Category	getCategory () const Returns the category of the data graph event.
SBDDataGraphNode *	getSender () const Returns the sender of the event.
virtual void	print (unsigned int offset=0) const Prints debugging information.
virtual	~SBDDataGraphEvent () Destructor.

Public Static Functions#

Type	Name
std::string	getTypeString (Type type) Returns the simulator event type as a string.

Public Static Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
std::string	getCategoryString (Category category) Returns a string representation of the category of the data graph event.

Protected Attributes#

Type	Name
Type	eventType The event type.

Protected Attributes inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
SBDDataGraphEventData *	dataPointer A pointer to the private data.

Protected Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphEventData * dataPointer) Protected constructor.

Detailed Description#

Short name: SBSimulatorEvent

Public Types Documentation#

enum Type#

The type of the simulator event.

enum SBSSimulatorEvent::Type {
    ActivityFlagChanged = 1,
    StateUpdateBegin = 2,
    StateUpdateEnd = 3
};

Public Functions Documentation#

function SBSSimulatorEvent#

Builds a simulator event.

SBSSimulatorEvent::SBSSimulatorEvent (
    SBSSimulator * sender,
    Type type
)

Constructs a SBSSimulatorEvent with the specified sender and type.

Parameters:

sender Pointer to the SBSSimulator that sends the event.
type The type of the simulator event.

function getCategory#

Returns the category of the event.

virtual Category SBSSimulatorEvent::getCategory () override const

Returns the event category for SBSSimulatorEvent.

Returns:

The category indicating a simulator event.

Implements SBDDataGraphEvent::getCategory

function getSender#

Returns the sender of the event.

SBSSimulator * SBSSimulatorEvent::getSender () const

Returns the sender of this event as a SBSSimulator pointer.

Returns:

Pointer to the SBSSimulator that sent the event, or nullptr if undefined.

function getType#

Returns the simulator event type.

Type SBSSimulatorEvent::getType () const

Returns the type of this SBSSimulatorEvent.

Returns:

The event type.

function print#

Prints debugging information.

virtual void SBSSimulatorEvent::print (
    unsigned int offset=0
) override const

Prints debugging information about the event, indented by the given offset.

Parameters:

offset Number of tab characters to prepend to the output for indentation.

Implements SBDDataGraphEvent::print

function ~SBSSimulatorEvent#

Destructor.

virtual SBSSimulatorEvent::~SBSSimulatorEvent ()

Destroys the SBSSimulatorEvent.

Public Static Functions Documentation#

function getTypeString#

Returns the simulator event type as a string.

static std::string SBSSimulatorEvent::getTypeString (
    Type type
)

Returns a string representation of the given SBSSimulatorEvent type.

Parameters:

type The event type to be converted to a string.

Returns:

A string describing the event type.

Protected Attributes Documentation#

variable eventType#

The event type.

Type SBSSimulatorEvent::eventType;