BeeeOn Gateway  v2020.3.1-2-g6f737dc
Platform to interconnect the IoT world
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
BeeeOn::ZWaveNetwork::PollEvent Class Reference

Representation of events reported by the ZWaveNetwork implementation via the call pollEvent(). More...

#include <ZWaveNetwork.h>

Public Types

enum  Type {
  EVENT_NONE = 0, EVENT_NEW_NODE = 1, EVENT_UPDATE_NODE = 2, EVENT_REMOVE_NODE = 3,
  EVENT_VALUE = 4, EVENT_INCLUSION_START = 5, EVENT_INCLUSION_DONE = 7, EVENT_REMOVE_NODE_START = 8,
  EVENT_REMOVE_NODE_DONE = 9, EVENT_READY = 10
}
 

Public Member Functions

bool isNone () const
 
Type type () const
 
const ZWaveNodenode () const
 
const ZWaveNode::Valuevalue () const
 
std::string toString () const
 

Static Public Member Functions

static PollEvent createNewNode (const ZWaveNode &node)
 
static PollEvent createUpdateNode (const ZWaveNode &node)
 
static PollEvent createRemoveNode (const ZWaveNode &node)
 
static PollEvent createValue (const ZWaveNode::Value &value)
 
static PollEvent createInclusionStart ()
 
static PollEvent createInclusionDone ()
 
static PollEvent createRemoveNodeStart ()
 
static PollEvent createRemoveNodeDone ()
 
static PollEvent createReady ()
 

Protected Member Functions

 PollEvent (Type type)
 
 PollEvent (Type type, const ZWaveNode &node)
 
 PollEvent (const ZWaveNode::Value &value)
 

Detailed Description

Representation of events reported by the ZWaveNetwork implementation via the call pollEvent().

Member Enumeration Documentation

Enumerator
EVENT_NONE 

Dummy, nothing happens. It might come when interrupted for some reason (termination). It can be just a spurious wakeup.

EVENT_NEW_NODE 

A new Z-Wave node has been detected. There might be incomplete information about it. Use method PollEvent::node() to access it.

EVENT_UPDATE_NODE 

A Z-Wave node's information has been updated. Use method PollEvent::node() to access it.

EVENT_REMOVE_NODE 

A Z-Wave node has been removed from the Z-Wave network. Use method PollEvent::node() to access it.

EVENT_VALUE 

Received data from a Z-Wave node. Use method PollEvent::value() to access it.

EVENT_INCLUSION_START 

Z-Wave inclusion process has started.

EVENT_INCLUSION_DONE 

Z-Wave inclusion process has stopped.

EVENT_REMOVE_NODE_START 

Z-Wave node removal process has started.

EVENT_REMOVE_NODE_DONE 

Z-Wave node removal process has stopped.

EVENT_READY 

All available Z-Wave nodes have been queried.


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