SBDDataGraphEvent Class Reference

This class is the base class to describe a data graph event. More...

Event categories
enum	Category {   UndefinedEvent ,   BaseEvent ,   DocumentEvent ,   StructuralEvent ,   VisualEvent ,   DynamicalEvent ,   InteractionEvent ,   PropertyEvent ,   StateUpdaterEvent ,   SimulatorEvent ,   ControllerEvent ,   AssetEvent }
	The category of the data graph event. More...

Debugging
SBDDataGraphEventData *	dataPointer
virtual void	print (unsigned int offset=0) const
	Prints debugging information.
	SB_DECLARE_DATA (SBDDataGraphEvent)
	SBDDataGraphEvent (SBDDataGraphEventData *dataPointer)

Constructors and destructors
	SBDDataGraphEvent (SBDDataGraphNode *sender)
virtual	~SBDDataGraphEvent ()

Identity
virtual Category	getCategory () const
	Returns the category of the data graph event.
SBDDataGraphNode *	getSender () const
	Returns the sender of the event.
static std::string	getCategoryString (Category category)
	Returns a string representation of the category of the data graph event.

Detailed Description

Short name: SBEvent

Member Enumeration Documentation

Category

enum SBDDataGraphEvent::Category

Enumerator
UndefinedEvent	An undefined event category.
BaseEvent	See SBBaseEvent.
DocumentEvent	See SBDocumentEvent.
StructuralEvent	See SBStructuralEvent.
VisualEvent	See SBVisualEvent.
DynamicalEvent	See SBDynamicalEvent.
InteractionEvent	See SBInteractionEvent.
PropertyEvent	See SBPropertyEvent.
StateUpdaterEvent	See SBStateUpdaterEvent.
SimulatorEvent	See SBSimulatorEvent.
ControllerEvent	See SBControllerEvent.
AssetEvent	See SBAssetEvent.

Member Function Documentation

getCategory()

SBDDataGraphEvent::Category SBDDataGraphEvent::getCategory ( ) const

virtual

Reimplemented in SBDDataGraphBaseEvent, SBDAssetEvent, SBDControllerEvent, SBDDocumentEvent, SBMDynamicalModelEvent, SBMInteractionModelEvent, SBMPropertyModelEvent, SBMStructuralModelEvent, SBMVisualModelEvent, SBSSimulatorEvent, and SBSStateUpdaterEvent.

getCategoryString()

std::string SBDDataGraphEvent::getCategoryString ( SBDDataGraphEvent::Category  category )

static

Parameters

category

An event's category

This function returns the string representation of the event's category category

getSender()

SBDDataGraphNode * SBDDataGraphEvent::getSender

(

)

const

This function returns the sender of an event.

print()

void SBDDataGraphEvent::print ( unsigned int  offset = 0 ) const

virtual

Reimplemented in SBDDataGraphBaseEvent, SBDAssetEvent, SBDControllerEvent, SBDDocumentEvent, SBMDynamicalModelEvent, SBMInteractionModelEvent, SBMPropertyModelEvent, SBMStructuralModelEvent, SBMVisualModelEvent, SBSSimulatorEvent, and SBSStateUpdaterEvent.