Class SBMDynamicalModelEvent

ClassList > SBMDynamicalModelEvent

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=0) Builds a dynamical event.
	SB_DECLARE_DATA (SBMDynamicalModelEvent)
SBDDataGraphNode *	getAuxiliaryNode () const
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)
	SB_DECLARE_DATA (SBDDataGraphEvent)
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 ()

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

Protected Functions inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphEventData * dataPointer)

Detailed Description

This class describes a dynamical event.

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=0
) 

---

function SB_DECLARE_DATA

SBMDynamicalModelEvent::SB_DECLARE_DATA (
    SBMDynamicalModelEvent
) 

---

function getAuxiliaryNode

SBDDataGraphNode * SBMDynamicalModelEvent::getAuxiliaryNode () const

---

function getCategory

Returns the category of the event.

virtual Category SBMDynamicalModelEvent::getCategory () override const

Implements SBDDataGraphEvent::getCategory

---

function getType

Returns the dynamical model event type.

Type SBMDynamicalModelEvent::getType () const

---

function print

Prints debugging information.

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

Implements SBDDataGraphEvent::print

---

function ~SBMDynamicalModelEvent

Deletes the dynamical event.

virtual SBMDynamicalModelEvent::~SBMDynamicalModelEvent () 

---

Public Static Functions Documentation

function getTypeString

Returns the dynamical model event type as a string.

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

---