Veethree D7 SDK
Loading...
Searching...
No Matches
vsdk::io::state_event Class Reference

Detailed Description

The state_event class.

Class interface for all state-type events.

#include <io_state_event.h>

Public Member Functions

 state_event (event_source evt_src, event_type evt_type, bool state, bool value)
 Constructor that takes all required values for creating a state_event object.
 state_event ()
 Default constructor.
 state_event (const state_event &evt)
 Copy constructor.
 state_event (state_event &&evt) noexcept
 Move constructor.
event_source source () const override
 The event source as defined by vsdk::io::event_source.
event_type type () const override
 The event type as defined by vsdk::io::event_type.
bool criteria () const
 The event state value criteria for this event.
bool value () const
 The value used when determining if the event should have been created.
void get_data (event_data &e) const override
 Get data from a state event object.
state_event & operator= (const state_event &evt)
 Assignment operators.
state_event & operator= (state_event &&evt) noexcept
 Assignment operators.
Public Member Functions inherited from vsdk::io::event
virtual ~event () noexcept=default
 The class destructor.

Detailed Description

The state_event class.

Class interface for all state-type events.

Constructor & Destructor Documentation

◆ state_event() [1/3]

vsdk::io::state_event::state_event ( event_source evt_src,
event_type evt_type,
bool state,
bool value )

Constructor that takes all required values for creating a state_event object.

Parameters
evt_srcThe vsdk::io::event_source for the event.
evt_typeThe vsdk::io::event_type for the event.
stateThe criteria for this event.
valueThe value that triggered this event.

◆ state_event() [2/3]

vsdk::io::state_event::state_event ( const state_event & evt)

Copy constructor.

Parameters
evtThe other vsdk::io::state_event object.

◆ state_event() [3/3]

vsdk::io::state_event::state_event ( state_event && evt)
noexcept

Move constructor.

Parameters
evtThe other vsdk::io::state_event object.

Member Function Documentation

◆ criteria()

bool vsdk::io::state_event::criteria ( ) const

The event state value criteria for this event.

Returns
A bool value.

◆ get_data()

void vsdk::io::state_event::get_data ( event_data & e) const
overridevirtual

Get data from a state event object.

Parameters
eA state_event_data object.

Sample code:

using namespace vsdk::io;
void fn_handler(std::shared_ptr<event> e)
{
e->get_data(data);
// use data...
}
The state_event_data class.
Definition io_state_event.h:111
IO state event interface.
Any entities that belong to the IO library.

Implements vsdk::io::event.

◆ source()

event_source vsdk::io::state_event::source ( ) const
overridevirtual

The event source as defined by vsdk::io::event_source.

Returns
A vsdk::io::event_source value.

Implements vsdk::io::event.

◆ type()

event_type vsdk::io::state_event::type ( ) const
overridevirtual

The event type as defined by vsdk::io::event_type.

Returns
A vsdk::io::event_type value.

Implements vsdk::io::event.

◆ value()

bool vsdk::io::state_event::value ( ) const

The value used when determining if the event should have been created.

Returns
A bool value used to evaluate the event.

The documentation for this class was generated from the following file: