Class SBDDataGraphEvent#

This class is the base class to describe a data graph event. More...

#include <SBDDataGraphEvent.hpp>

Inherited by the following classes: SBDAssetEvent, SBDControllerEvent, SBDDataGraphBaseEvent, SBDDocumentEvent, SBMDynamicalModelEvent, SBMInteractionModelEvent, SBMPropertyModelEvent, SBMStructuralModelEvent, SBMVisualModelEvent, SBSSimulatorEvent, SBSStateUpdaterEvent

Public Types#

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

Public Functions#

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	getCategoryString (Category category) Returns a string representation of the category of the data graph event.

Protected Attributes#

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

Protected Functions#

Type	Name
	SBDDataGraphEvent (SBDDataGraphEventData * dataPointer) Protected constructor.

Detailed Description#

Short name: SBEvent

Public Types Documentation#

enum Category#

The category of the data graph event.

enum SBDDataGraphEvent::Category {
    UndefinedEvent = 0,
    BaseEvent = 1,
    DocumentEvent = 2,
    StructuralEvent = 3,
    VisualEvent = 4,
    DynamicalEvent = 5,
    InteractionEvent = 6,
    PropertyEvent = 7,
    StateUpdaterEvent = 8,
    SimulatorEvent = 9,
    ControllerEvent = 10,
    AssetEvent = 11
};

Public Functions Documentation#

function SBDDataGraphEvent [2/2]#

Build a data graph event for the sender sender .

SBDDataGraphEvent::SBDDataGraphEvent (
    SBDDataGraphNode * sender
)

Constructs a data graph event with the given sender node.

This constructor creates a new event and associates it with the specified sender.

Parameters:

sender Pointer to the node that sends the event.

function getCategory#

Returns the category of the data graph event.

virtual Category SBDDataGraphEvent::getCategory () const

Returns the category of this data graph event.

The category identifies the type of the event; derived classes may override this method to provide a specific category.

Returns:

The event category.

function getSender#

Returns the sender of the event.

SBDDataGraphNode * SBDDataGraphEvent::getSender () const

Returns the sender of this event.

The sender is the node that originated the event.

Returns:

Pointer to the event sender node, or nullptr if no sender is set.

function print#

Prints debugging information.

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

Prints debugging information for the event.

The function outputs details about the event, prefixed by a number of tab characters equal to the specified offset.

Parameters:

offset Number of indentation levels (tabs) to prepend to the output.

function ~SBDDataGraphEvent#

Destructor.

virtual SBDDataGraphEvent::~SBDDataGraphEvent ()

Destroys the data graph event and releases associated resources.

Public Static Functions Documentation#

function getCategoryString#

Returns a string representation of the category of the data graph event.

static std::string SBDDataGraphEvent::getCategoryString (
    Category category
)

Returns the string representation of the given event category.

This function returns the string representation of the event's category category.

Parameters:

category An event's category.

Returns:

String describing the category.

Protected Attributes Documentation#

variable dataPointer#

A pointer to the private data.

SBDDataGraphEventData* SBDDataGraphEvent::dataPointer;

Protected Functions Documentation#

function SBDDataGraphEvent [1/2]#

Protected constructor.

SBDDataGraphEvent::SBDDataGraphEvent (
    SBDDataGraphEventData * dataPointer
)

Constructs a data graph event from existing internal data.

This constructor initializes the event using a pre-existing data object.

Parameters:

dataPointer Pointer to the internal event data.