Class SBMDynamicalModelEvent

ClassList > SBMDynamicalModelEvent

This class describes a dynamical event. More...

• #include <SBMDynamicalModelEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types

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

Public Types inherited from SBDDataGraphEvent

See SBDDataGraphEvent

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

Public Functions

Type	Name
	SBMDynamicalModelEvent (SBDDataGraphNode * sender, Type type, SBDDataGraphNode * auxiliaryNode=nullptr) Builds a dynamical event.
SBDDataGraphNode *	getAuxiliaryNode () const Retrieves the auxiliary node associated with the event, if any.
virtual Category	getCategory () override const Returns the category of the event.
Type	getType () const Returns the dynamical model event type.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual	~SBMDynamicalModelEvent () 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 dynamical 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 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: SBDynamicalEvent

Public Types Documentation

enum Type

The type of the dynamical model event.

enum SBMDynamicalModelEvent::Type {
    DynamicalModelChanged = 0,
    ChildAdded = 1,
    ChildRemoved = 2,
    PositionBufferFlushBegin = 3,
    PositionBufferFlushEnd = 4,
    MomentumBufferFlushBegin = 5,
    MomentumBufferFlushEnd = 6,
    ActivityFlagChanged = 7,
    MassChanged = 8,
    PeriodicBoundaryConditionsChanged = 9,
    PeriodicBoundaryConditionsFlagChanged = 10,
    AtomAddBegin = 11,
    AtomAddEnd = 12,
    AtomRemoveBegin = 13,
    AtomRemoveEnd = 14,
    StructuralModelAddBegin = 15,
    StructuralModelAddEnd = 16,
    StructuralModelRemoveBegin = 17,
    StructuralModelRemoveEnd = 18
};

---

Public Functions Documentation

function SBMDynamicalModelEvent

Builds a dynamical event.

SBMDynamicalModelEvent::SBMDynamicalModelEvent (
    SBDDataGraphNode * sender,
    Type type,
    SBDDataGraphNode * auxiliaryNode=nullptr
) 

Constructs a dynamical model event.

Creates a new SBMDynamicalModelEvent with the specified sender, event type, and optional auxiliary node.

Parameters:

• sender The node that originated the event.
• type The type of the dynamical model event.
• auxiliaryNode An optional node providing additional context for the event; may be nullptr.

---

function getAuxiliaryNode

Retrieves the auxiliary node associated with the event, if any.

SBDDataGraphNode * SBMDynamicalModelEvent::getAuxiliaryNode () const

Returns:

Pointer to the auxiliary node, or nullptr if none was provided.

---

function getCategory

Returns the category of the event.

virtual Category SBMDynamicalModelEvent::getCategory () override const

Retrieves the category of the event.

Returns:

The event category, which is DynamicalEvent.

Implements SBDDataGraphEvent::getCategory

---

function getType

Returns the dynamical model event type.

Type SBMDynamicalModelEvent::getType () const

Retrieves the specific type of the dynamical model event.

Returns:

The event type.

---

function print

Prints debugging information.

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

Prints debugging information about the event to standard output.

Parameters:

• offset Number of tab characters to indent the output.

Implements SBDDataGraphEvent::print

---

function ~SBMDynamicalModelEvent

Deletes the dynamical event.

virtual SBMDynamicalModelEvent::~SBMDynamicalModelEvent () 

Destroys the dynamical model event.

---

Public Static Functions Documentation

function getTypeString

Returns the dynamical model event type as a string.

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

Converts an event type enumeration value to its string representation.

Parameters:

• type The event type to convert.

Returns:

A string describing the event type.

---