Class SBSStateUpdaterEvent#

ClassList > SBSStateUpdaterEvent

This class describes a state updater event. More...

#include <SBSStateUpdaterEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type	Name
enum	Type The type of the state updater event.

Public Types inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

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

Public Functions#

Type	Name
	SBSStateUpdaterEvent (SBSStateUpdater * sender, Type type) Builds a dynamical event.
virtual Category	getCategory () override const Returns the category of the event.
SBSStateUpdater *	getSender () const Returns the sender of the event.
Type	getType () const Returns the state update event type.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual	~SBSStateUpdaterEvent () Deletes the dynamical event.

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 state update 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: SBStateUpdaterEvent

Public Types Documentation#

enum Type#

The type of the state updater event.

enum SBSStateUpdaterEvent::Type {
    StepSizeChanged = 1,
    NumberOfStepsChanged = 2,
    StateUpdaterChanged = 3
};

Public Functions Documentation#

function SBSStateUpdaterEvent#

Builds a dynamical event.

SBSStateUpdaterEvent::SBSStateUpdaterEvent (
    SBSStateUpdater * sender,
    Type type
)

Constructs a SBSStateUpdaterEvent.

Creates a state updater event with the given sender and type.

Parameters:

sender The SBSStateUpdater that sends the event.
type The type of the state updater event.

function getCategory#

Returns the category of the event.

virtual Category SBSStateUpdaterEvent::getCategory () override const

Returns:

The event category, which is StateUpdaterEvent.

Implements SBDDataGraphEvent::getCategory

function getSender#

Returns the sender of the event.

SBSStateUpdater * SBSStateUpdaterEvent::getSender () const

Returns the sender of the event as a SBSStateUpdater pointer.

Returns:

The sender of the event, or nullptr if there is none.

function getType#

Returns the state update event type.

Type SBSStateUpdaterEvent::getType () const

Returns the type of the state updater event.

Returns:

The specific event type.

function print#

Prints debugging information.

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

Prints debugging information for the event.

Parameters:

offset Number of tabs to indent the output.

Implements SBDDataGraphEvent::print

function ~SBSStateUpdaterEvent#

Deletes the dynamical event.

virtual SBSStateUpdaterEvent::~SBSStateUpdaterEvent ()

Destroys the SBSStateUpdaterEvent.

Public Static Functions Documentation#

function getTypeString#

Returns the state update event type as a string.

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

Returns a string representation of the given event type.

Parameters:

type The event type to convert to a string.

Returns:

A string describing the event type.

Protected Attributes Documentation#

variable eventType#

The event type.

Type SBSStateUpdaterEvent::eventType;