Class SBMPropertyModelEvent#
ClassList > SBMPropertyModelEvent
This class describes a property event. More...
#include <SBMPropertyModelEvent.hpp>
Inherits the following classes: SBDDataGraphEvent
Public Types#
| Type | Name |
|---|---|
| enum | Type The type of the property model event. |
Public Types inherited from SBDDataGraphEvent#
| Type | Name |
|---|---|
| enum | Category The category of the data graph event. |
Public Functions#
| Type | Name |
|---|---|
| SBMPropertyModelEvent (SBMPropertyModel * sender, Type type) Builds a property model event. |
|
| virtual Category | getCategory () override const Returns the category of the event. |
| SBIAPosition3 | getEventBoundaries () Returns the event boundaries. |
| SBMPropertyModel * | getSender () const Returns the sender of the event. |
| Type | getType () const Returns the property model event type. |
| virtual void | print (unsigned int offset=0) override const Prints debugging information. |
| void | setEventBoundaries (const SBIAPosition3 & volume) Sets the event boundaries. |
| virtual | ~SBMPropertyModelEvent () Destructor. |
Public Functions inherited from 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 the property model event type as a string. |
Public Static Functions inherited from SBDDataGraphEvent#
| Type | Name |
|---|---|
| std::string | getCategoryString (Category category) Returns a string representation of the category of the data graph event. |
Protected Attributes#
| Type | Name |
|---|---|
| SBIAPosition3 * | eventBoundaries The event boundaries. |
| Type | eventType The event type. |
Protected Attributes inherited from SBDDataGraphEvent#
| Type | Name |
|---|---|
| SBDDataGraphEventData * | dataPointer A pointer to the private data. |
Protected Functions inherited from SBDDataGraphEvent#
| Type | Name |
|---|---|
| SBDDataGraphEvent (SBDDataGraphEventData * dataPointer) Protected constructor. |
Detailed Description#
Short name: SBPropertyEvent
Public Types Documentation#
enum Type#
The type of the property model event.
Public Functions Documentation#
function SBMPropertyModelEvent#
Builds a property model event.
Constructs a SBMPropertyModelEvent with the given sender and type.
Initializes the event with the specified sender and event type.
Parameters:
senderThe property model that emits the event.typeThe type of the property model event.
function getCategory#
Returns the category of the event.
Returns the category of this event.
The category identifies the kind of event within the data graph system.
Returns:
The category of the event (PropertyEvent).
Implements SBDDataGraphEvent::getCategory
function getEventBoundaries#
Returns the event boundaries.
Returns the current event boundaries.
Returns:
The event boundaries as an SBIAPosition3 object.
function getSender#
Returns the sender of the event.
Returns the sender of this event as a SBMPropertyModel pointer.
Returns:
The sender of the event, or nullptr if no sender is set.
function getType#
Returns the property model event type.
Returns the specific type of this property model event.
Returns:
The type of the event.
function print#
Prints debugging information.
Prints debugging information about the event to standard output.
Parameters:
offsetNumber of tab characters to indent the output.
Implements SBDDataGraphEvent::print
function setEventBoundaries#
Sets the event boundaries.
Sets the event boundaries to the specified volume.
Parameters:
volumeThe volume defining the event boundaries.
function ~SBMPropertyModelEvent#
Destructor.
Destroys the SBMPropertyModelEvent and releases its resources.
Public Static Functions Documentation#
function getTypeString#
Returns the property model event type as a string.
Returns a string representation of the given event type.
Parameters:
typeThe event type to convert to a string.
Returns:
A string describing the event type.
Protected Attributes Documentation#
variable eventBoundaries#
The event boundaries.
variable eventType#
The event type.