Loading...
Searching...
No Matches
SBSStateUpdaterEvent Class Reference

This class describes a state updater event.

Event types

enum  Type {
  StepSizeChanged ,
  NumberOfStepsChanged ,
  StateUpdaterChanged
}
 The type of the state updater event. More...
 

Identity attributes

Type eventType
 The event type.
 

Constructors and destructors

 SBSStateUpdaterEvent (SBSStateUpdater *sender, Type type)
 Builds a dynamical event.
 
virtual ~SBSStateUpdaterEvent ()
 Deletes the dynamical event.
 

Identity

virtual Category getCategory () const override
 Returns the category of the event.
 
Type getType () const
 Returns the state update event type.
 
SBSStateUpdatergetSender () const
 Returns the sender of the event.
 
static std::string getTypeString (Type type)
 Returns the state update event type as a string.
 

Debugging

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

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
StepSizeChanged 

A step size was changed.

NumberOfStepsChanged 

A number of steps size was changed.

StateUpdaterChanged 

A state updater was changed.

Member Function Documentation

◆ getCategory()

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

Reimplemented from SBDDataGraphEvent.

◆ print()

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

Reimplemented from SBDDataGraphEvent.