Class SBMInteractionModelEvent#

ClassList > SBMInteractionModelEvent

This class describes an interaction event. More...

#include <SBMInteractionModelEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type	Name
enum	Type The type of the interaction model event.

Public Types inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

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

Public Functions#

Type	Name
	SBMInteractionModelEvent (SBMInteractionModel * sender, Type type) Builds an interaction model event.
virtual Category	getCategory () override const Returns the category of the event.
SBMInteractionModel *	getSender () const Returns the sender of the event.
Type	getType () const Returns the interaction model event type.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual	~SBMInteractionModelEvent () 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 interaction model 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: SBInteractionEvent

Public Types Documentation#

enum Type#

The type of the interaction model event.

enum SBMInteractionModelEvent::Type {
    ForceBufferFlushBegin = 1,
    ForceBufferFlushEnd = 2,
    InteractionModelChanged = 3
};

Public Functions Documentation#

function SBMInteractionModelEvent#

Builds an interaction model event.

SBMInteractionModelEvent::SBMInteractionModelEvent (
    SBMInteractionModel * sender,
    Type type
)

Constructs an SBMInteractionModelEvent.

Parameters:

sender The interaction model that sends the event.
type The type of the interaction model event.

function getCategory#

Returns the category of the event.

virtual Category SBMInteractionModelEvent::getCategory () override const

Returns the category of this event.

Returns:

The event category (InteractionEvent).

Implements SBDDataGraphEvent::getCategory

function getSender#

Returns the sender of the event.

SBMInteractionModel * SBMInteractionModelEvent::getSender () const

Retrieves the sender of the event as an SBMInteractionModel pointer.

Returns:

Pointer to the SBMInteractionModel that sent the event, or nullptr if no sender.

function getType#

Returns the interaction model event type.

Type SBMInteractionModelEvent::getType () const

Returns the specific type of this interaction model event.

Returns:

The event type.

function print#

Prints debugging information.

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

Prints debugging information about the interaction event to standard output.

Parameters:

offset Number of tab characters to indent the printed output.

Implements SBDDataGraphEvent::print

function ~SBMInteractionModelEvent#

Destructor.

virtual SBMInteractionModelEvent::~SBMInteractionModelEvent ()

Destructor for SBMInteractionModelEvent.

Public Static Functions Documentation#

function getTypeString#

Returns the interaction model event type as a string.

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

Returns a string representation of the given event type.

Parameters:

type The event type to convert.

Returns:

A human‑readable string describing the event type, or a default message for unknown types.

Protected Attributes Documentation#

variable eventType#

The event type.

Type SBMInteractionModelEvent::eventType;