Class SBDDataGraphBaseEvent

ClassList > SBDDataGraphBaseEvent

This class describes a base event. More...

• #include <SBDDataGraphBaseEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types

Type	Name
enum	Type The type of the data graph base event.

Public Types inherited from SBDDataGraphEvent

See SBDDataGraphEvent

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

Public Functions

Type	Name
	SBDDataGraphBaseEvent (SBDDataGraphNode * sender, Type type) Builds a base event.
virtual Category	getCategory () const Returns the category of the event.
Type	getType () const Returns the type of the data graph base event.
virtual void	print (unsigned int offset=0) const Prints some debugging information.
virtual	~SBDDataGraphBaseEvent () Destructor.

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 a string describing the type of the data graph base event.

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

Type	Name
	SBDDataGraphBaseEvent (SBDDataGraphBaseEventData * dataPointer) Protected constructor.

Protected Functions inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphEventData * dataPointer) Protected constructor.

Detailed Description

Short name: SBBaseEvent

Public Types Documentation

enum Type

The type of the data graph base event.

enum SBDDataGraphBaseEvent::Type {
    NodeCreated = 0,
    NodeEraseBegin = 1,
    NodeEraseEnd = 2,
    NodeErased = 3,
    NodeDeleteBegin = 4,
    NodeDeleteEnd = 5,
    NodeDeleted = 6,
    SelectionFlagChanged = 10,
    VisibilityFlagChanged = 11,
    HighlightingFlagChanged = 12,
    IndexChanged = 14,
    NameChanged = 15,
    Shown = 16,
    Hidden = 17,
    MaterialAdded = 18,
    MaterialRemoved = 19,
    MaterialChanged = 20,
    UUIDChanged = 21,
    LockedFlagChanged = 22,
    TransparencyChanged = 23,
    ShadowingFlagChanged = 24,
    ParentChanged = 25,
    SourceFileNameChanged = 40
};

---

Public Functions Documentation

function SBDDataGraphBaseEvent [1/2]

Builds a base event.

SBDDataGraphBaseEvent::SBDDataGraphBaseEvent (
    SBDDataGraphNode * sender,
    Type type
) 

Constructs a base event with the given sender node and event type.

Initializes a new SBDDataGraphBaseEvent instance.

Parameters:

• sender Pointer to the node that sends the event.
• type The type of the base event.

---

function getCategory

Returns the category of the event.

virtual Category SBDDataGraphBaseEvent::getCategory () const

This function returns the event category identifying it as a base event.

Returns:

The event category (BaseEvent).

Implements SBDDataGraphEvent::getCategory

---

function getType

Returns the type of the data graph base event.

Type SBDDataGraphBaseEvent::getType () const

Returns the type of the base event.

Retrieves the specific type identifier for this base event.

Returns:

The type of the data graph base event.

---

function print

Prints some debugging information.

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

Prints debugging information about the base event.

The output includes the event type and sender information, indented by the specified offset.

Parameters:

• offset Number of tab characters to indent the output.

Implements SBDDataGraphEvent::print

---

function ~SBDDataGraphBaseEvent

Destructor.

virtual SBDDataGraphBaseEvent::~SBDDataGraphBaseEvent () 

Destroys the base event.

---

Public Static Functions Documentation

function getTypeString

Returns a string describing the type of the data graph base event.

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

Returns a string describing the given base event type.

This function returns the string representation of the base event type type.

Parameters:

• type A type of the base event.

Returns:

A string describing the base event type.

---

Protected Functions Documentation

function SBDDataGraphBaseEvent [2/2]

Protected constructor.

SBDDataGraphBaseEvent::SBDDataGraphBaseEvent (
    SBDDataGraphBaseEventData * dataPointer
) 

Constructs a base event from the given internal data pointer.

This protected constructor is used internally to create an event from existing data.

Parameters:

• dataPointer Pointer to the internal event data.

---