An event provided by a plugin.
More...
#include <process/Event.hpp>
An event provided by a plugin.
- See also
- Publishing Tasks
-
Events in the Xentara user manual
◆ Event() [1/4]
xentara::process::Event::Event |
( |
| ) |
|
|
default |
Constructor for a regular event.
◆ Event() [2/4]
Constructor for an attribute change event.
This constructor marks this event as the change event for a particular attribute. If the attribute is an I/O attribute, then the event is automatically marked as an I/O event.
- Attention
- The event is not automatically fired when the attribute's value changes. You must fire the event manually when you change the attribute's value.
- Parameters
-
attribute | The attribute whose change this event signals. |
◆ Event() [3/4]
Constructor for an attribute change event.
This constructor marks this event as the change event for an attribute with a particular role. If the role is a role for an I/O attribute, then the event is automatically marked as an I/O event.
- Attention
- The event is not automatically fired when the value of the attribute with the given role changes. You must fire the event manually when you change the attribute's value.
- Parameters
-
attributeRole | The attribute whose change this event signals. |
◆ Event() [4/4]
Constructor for an I/O event.
- Parameters
-
ioDirections | The relevant I/O directions. |
The I/O directions are used for I/O events to specify whether a data point should inherit this event from its I/O points. If the directions contain the flag io::Direction::Input, then the data point will inherit this event from its input I/O point. If the directions contain the flag io::Direction::Output, then the data point will inherit this event from its output I/O point. If you do not set either flag (the default), then the event will not be considered an I/O event and will not be inherited. This is equivalent to calling the default constructor.
◆ fire()
You must call this function to fire the event.
This function fires the event asynchronously and returns immediately.
- Parameters
-
eventTime | The (canonical) time the event occurred |
◆ ioDirections()
internal auto xentara::process::Event::ioDirections |
( |
| ) |
const -> io::Directions
|
Gets the relevant I/O directions.
- Returns
- The I/O directions. The I/O directions are used for I/O events to specify whether a data point should inherit this event from its I/O points.
◆ setIoDirections()
auto xentara::process::Event::setIoDirections |
( |
io::Directions |
ioDirections | ) |
-> void
|
Sets the relevant I/O directions.
- Parameters
-
ioDirections | The desired I/O directions. The I/O directions are used for I/O events to specify whether a data point should inherit this event from its I/O points. |
◆ kChanged
The standard name for the change event of an I/O or data point.
◆ kConnected
The standard name for the connection event of an I/O component.
◆ kDisconnected
The standard name for the disconnection event of an I/O component.