Loading...
Searching...
No Matches
SBMDynamicalModelEvent Class Reference

This class describes a dynamical event.

Event types

enum  Type {
  DynamicalModelChanged ,
  ChildAdded ,
  ChildRemoved ,
  PositionBufferFlushBegin ,
  PositionBufferFlushEnd ,
  MomentumBufferFlushBegin ,
  MomentumBufferFlushEnd ,
  ActivityFlagChanged ,
  MassChanged ,
  PeriodicBoundaryConditionsChanged ,
  PeriodicBoundaryConditionsFlagChanged ,
  AtomAddBegin ,
  AtomAddEnd ,
  AtomRemoveBegin ,
  AtomRemoveEnd ,
  StructuralModelAddBegin ,
  StructuralModelAddEnd ,
  StructuralModelRemoveBegin ,
  StructuralModelRemoveEnd
}
 The type of the dynamical model event. More...
 

Constructors and destructors

 SBMDynamicalModelEvent (SBDDataGraphNode *sender, Type type, SBDDataGraphNode *auxiliaryNode=0)
 Builds a dynamical event.
 
virtual ~SBMDynamicalModelEvent ()
 Deletes the dynamical event.
 

Identity

virtual Category getCategory () const override
 Returns the category of the event.
 
Type getType () const
 Returns the dynamical model event type.
 
SBDDataGraphNodegetAuxiliaryNode () const
 
static std::string getTypeString (Type type)
 Returns the dynamical model event type as a string.
 

Debugging

virtual void print (unsigned int offset=0) const override
 Prints debugging information.
 
 SB_DECLARE_DATA (SBMDynamicalModelEvent)
 

Additional Inherited Members

- Public Types inherited from SBDDataGraphEvent
enum  Category {
  UndefinedEvent ,
  BaseEvent ,
  DocumentEvent ,
  StructuralEvent ,
  VisualEvent ,
  DynamicalEvent ,
  InteractionEvent ,
  PropertyEvent ,
  StateUpdaterEvent ,
  SimulatorEvent ,
  ControllerEvent ,
  AssetEvent
}
 The category of the data graph event. More...
 
- Public Member Functions inherited from SBDDataGraphEvent
 SB_DECLARE_DATA (SBDDataGraphEvent)
 
 SBDDataGraphEvent (SBDDataGraphNode *sender)
 
virtual ~SBDDataGraphEvent ()
 
SBDDataGraphNodegetSender () const
 Returns the sender of the event.
 
- Static Public Member Functions inherited from SBDDataGraphEvent
static std::string getCategoryString (Category category)
 Returns a string representation of the category of the data graph event.
 
- Protected Member Functions inherited from SBDDataGraphEvent
 SBDDataGraphEvent (SBDDataGraphEventData *dataPointer)
 
- Protected Attributes inherited from SBDDataGraphEvent
SBDDataGraphEventData * dataPointer
 

Member Enumeration Documentation

◆ Type

Enumerator
DynamicalModelChanged 

A dynamical model was changed.

ChildAdded 

A child was added.

ChildRemoved 

A child was removed.

PositionBufferFlushBegin 

Position buffer flush started.

PositionBufferFlushEnd 

Position buffer flush finished.

MomentumBufferFlushBegin 

Momentum buffer flush started.

MomentumBufferFlushEnd 

Momentum buffer flush finished.

ActivityFlagChanged 

An activity flag was changed.

MassChanged 

Mass was changed.

PeriodicBoundaryConditionsChanged 

Periodic boundary conditions were changed.

PeriodicBoundaryConditionsFlagChanged 

Periodic boundary conditions flag was changed.

AtomAddBegin 

An addition of an atom started.

AtomAddEnd 

An addition of an atom finished.

AtomRemoveBegin 

A removal of an atom started.

AtomRemoveEnd 

A removal of an atom finished.

StructuralModelAddBegin 

An addition of a structural model started.

StructuralModelAddEnd 

An addition of a structural model finished.

StructuralModelRemoveBegin 

A removal of a structural model started.

StructuralModelRemoveEnd 

A removal of a structural model finished.

Member Function Documentation

◆ getCategory()

SBDDataGraphEvent::Category SBMDynamicalModelEvent::getCategory ( ) const
overridevirtual

Reimplemented from SBDDataGraphEvent.

◆ print()

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

Reimplemented from SBDDataGraphEvent.