Home2L - Python API v1.4-0-g38cc (2024-05-25)
Smart Tools for a Private Home
Public Member Functions | List of all members
CRcEvent Class Reference

Description

Resource events delivered by a subscriber or to a driver.

Possible event types are:
  rceTimer:             Timer alarm.
  rceValueStateChanged: The resource has changed its value.
  rceRequestChanged:    A request has been changed or deleted. The 'ValueState ()'
                        attribute indicates the affected request ID (type is string).
  rceDisconnected:      The connection to the (remote) resource has
                        been lost.
  rceConnected:         The connection to the (remote) resource has
                        been established (again).
  rceDriveValue:        Drive a value (for drivers).
  rceNone:              Nothing (dummy event: ignore).
The attribute 'MorePending ()' indicates whether more events are waiting for the
same subscriber. This can be used for performance optimizations to avoid
unecessary recomputations.

Inherits object.

Public Member Functions

def Clear (self)
 
def Set (self, _type=rceNone, _resource=None, _valueState=None, _data=None)
 
def SetType (self, _type)
 
def SetResource (self, _resource)
 
def SetValueState (self, _valueState)
 
def SetData (self, _data)
 
def Type (self)
 
def Resource (self)
 
def ValueState (self)
 
def Data (self)
 
def ToStr (self, ret)
 

Member Function Documentation

◆ Clear()

def Clear (   self)
Clear(CRcEvent self)

◆ Set()

def Set (   self,
  _type = rceNone,
  _resource = None,
  _valueState = None,
  _data = None 
)
Set(CRcEvent self, ERcEventType _type=rceNone, CResource _resource=None, CRcValueState _valueState=None, void * _data=None)

◆ SetType()

def SetType (   self,
  _type 
)
SetType(CRcEvent self, ERcEventType _type)

◆ SetResource()

def SetResource (   self,
  _resource 
)
SetResource(CRcEvent self, CResource _resource)

◆ SetValueState()

def SetValueState (   self,
  _valueState 
)
SetValueState(CRcEvent self, CRcValueState _valueState)

◆ SetData()

def SetData (   self,
  _data 
)
SetData(CRcEvent self, void * _data)

◆ Type()

def Type (   self)
Type(CRcEvent self) -> ERcEventType

◆ Resource()

def Resource (   self)
Resource(CRcEvent self) -> CResource

◆ ValueState()

def ValueState (   self)
ValueState(CRcEvent self) -> CRcValueState

◆ Data()

def Data (   self)
Data(CRcEvent self) -> void *

◆ ToStr()

def ToStr (   self,
  ret 
)
ToStr(CRcEvent self, CString * ret) -> char const *