VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxEvent Struct Referenceabstract

Represents an instance of a particular situation that has occurred. More...

#include <IVxEvent.h>

Public Member Functions

virtual VxResult::Value Acknowledge () const =0
 Acknowledges the event. More...
 
virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetGeneratorDevice (IVxDevice *&device) const =0
 Gets the device that the event was generated on. More...
 
virtual VxResult::Value GetSituation (IVxSituation *&situation) const =0
 Gets the situation that this event represents. More...
 
virtual VxResult::Value GetSourceDevice (IVxDevice *&device) const =0
 Gets the device that the situation occurred on. More...
 
virtual VxResult::Value GetUser (IVxUser *&user) const =0
 Gets the user that was the cause of the situation. More...
 
virtual VxResult::Value Refresh ()=0
 Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
 
virtual VxResult::Value Silence (int wakeup) const =0
 Silences the event for a given amount of time. More...
 

Public Attributes

bool isInitial
 Indicates whether the event is in its initial generated state (its ackState has not been updated). More...
 
char ackClientId [64]
 The identifier of the client that set the current ackState, if any. More...
 
char ackClientName [256]
 The friendly name of the client that set the current * ackState, if any. More...
 
char ackTime [256]
 The time at which the current ackState was set. More...
 
char ackUser [256]
 The user that set the current ackState, if any. More...
 
char generatorDeviceId [64]
 The unique identifier of the device that created and injected this event into the system. More...
 
char generatorDeviceName [256]
 The friendly name of the generator device, if any. More...
 
char id [64]
 The unique identifier created by the device that generated the event. More...
 
char situationType [256]
 The type of the situation that led to the generation of this event. More...
 
char sourceClientId [64]
 The client identifier of the client that was the cause of the situation, if any. More...
 
char sourceDeviceId [64]
 The unique identifier of the device that the situation occurred on. More...
 
char sourceDeviceName [256]
 The friendly name of the source device. More...
 
char sourceUserName [64]
 The name of the user that was the cause of the situation, if any. More...
 
char time [64]
 The time at which the situation occurred. More...
 
int propertySize
 The size of properties. More...
 
unsigned short severity
 The severity of the event, from 1 (highest) to 10 (lowest). More...
 
VxAckState::Value ackState
 The current acknowledgement state of the event. More...
 
VxKvObject ** properties
 Optional additional information related to the event. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents an instance of a particular situation that has occurred.

Definition at line 14 of file IVxEvent.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxEvent::Acknowledge ( ) const
pure virtual

Acknowledges the event.

Returns
The Result of the request.
void VxSdk::IVxEvent::Clear ( )
inlineprotected

Clears this instance.

Definition at line 142 of file IVxEvent.h.

142  {
143  this->isInitial = false;
144  VxZeroArray(this->ackClientId);
145  VxZeroArray(this->ackClientName);
146  VxZeroArray(this->ackTime);
147  VxZeroArray(this->ackUser);
148  VxZeroArray(this->generatorDeviceId);
149  VxZeroArray(this->generatorDeviceName);
150  VxZeroArray(this->id);
151  VxZeroArray(this->situationType);
152  VxZeroArray(this->sourceClientId);
153  VxZeroArray(this->sourceDeviceId);
154  VxZeroArray(this->sourceDeviceName);
155  VxZeroArray(this->sourceUserName);
156  VxZeroArray(this->time);
157  this->propertySize = 0;
158  this->severity = 0;
159  this->ackState = VxAckState::kUnknown;
160  this->properties = nullptr;
161  }
VxSdk::VxAckState::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:11
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxEvent::properties
VxKvObject ** properties
Optional additional information related to the event.
Definition: IVxEvent.h:136
VxSdk::IVxEvent::severity
unsigned short severity
The severity of the event, from 1 (highest) to 10 (lowest).
Definition: IVxEvent.h:128
VxSdk::IVxEvent::generatorDeviceName
char generatorDeviceName[256]
The friendly name of the generator device, if any.
Definition: IVxEvent.h:92
VxSdk::IVxEvent::situationType
char situationType[256]
The type of the situation that led to the generation of this event.
Definition: IVxEvent.h:100
VxSdk::IVxEvent::ackState
VxAckState::Value ackState
The current acknowledgement state of the event.
Definition: IVxEvent.h:132
VxSdk::IVxEvent::sourceUserName
char sourceUserName[64]
The name of the user that was the cause of the situation, if any.
Definition: IVxEvent.h:116
VxSdk::IVxEvent::sourceDeviceId
char sourceDeviceId[64]
The unique identifier of the device that the situation occurred on.
Definition: IVxEvent.h:108
VxSdk::IVxEvent::sourceClientId
char sourceClientId[64]
The client identifier of the client that was the cause of the situation, if any.
Definition: IVxEvent.h:104
VxSdk::IVxEvent::isInitial
bool isInitial
Indicates whether the event is in its initial generated state (its ackState has not been updated)...
Definition: IVxEvent.h:67
VxSdk::IVxEvent::sourceDeviceName
char sourceDeviceName[256]
The friendly name of the source device.
Definition: IVxEvent.h:112
VxSdk::IVxEvent::ackUser
char ackUser[256]
The user that set the current ackState, if any.
Definition: IVxEvent.h:83
VxSdk::IVxEvent::ackTime
char ackTime[256]
The time at which the current ackState was set.
Definition: IVxEvent.h:79
VxSdk::IVxEvent::ackClientName
char ackClientName[256]
The friendly name of the client that set the current * ackState, if any.
Definition: IVxEvent.h:75
VxSdk::IVxEvent::generatorDeviceId
char generatorDeviceId[64]
The unique identifier of the device that created and injected this event into the system...
Definition: IVxEvent.h:88
VxSdk::IVxEvent::propertySize
int propertySize
The size of properties.
Definition: IVxEvent.h:124
VxSdk::IVxEvent::ackClientId
char ackClientId[64]
The identifier of the client that set the current ackState, if any.
Definition: IVxEvent.h:71
VxSdk::IVxEvent::time
char time[64]
The time at which the situation occurred.
Definition: IVxEvent.h:120
virtual VxResult::Value VxSdk::IVxEvent::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxEvent::GetGeneratorDevice ( IVxDevice *&  device) const
pure virtual

Gets the device that the event was generated on.

Parameters
deviceThe generator device.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxEvent::GetSituation ( IVxSituation *&  situation) const
pure virtual

Gets the situation that this event represents.

Parameters
situationThe situation of the event.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxEvent::GetSourceDevice ( IVxDevice *&  device) const
pure virtual

Gets the device that the situation occurred on.

Parameters
deviceThe source device.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxEvent::GetUser ( IVxUser *&  user) const
pure virtual

Gets the user that was the cause of the situation.

Parameters
userThe user that caused the situation.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxEvent::Refresh ( )
pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns
The Result of refreshing the member values for this object.
virtual VxResult::Value VxSdk::IVxEvent::Silence ( int  wakeup) const
pure virtual

Silences the event for a given amount of time.

Parameters
wakeupThe delay, in seconds, to apply prior to the event being brought to the user’s attention.
Returns
The Result of the request.

Member Data Documentation

char VxSdk::IVxEvent::ackClientId[64]

The identifier of the client that set the current ackState, if any.

Definition at line 71 of file IVxEvent.h.

char VxSdk::IVxEvent::ackClientName[256]

The friendly name of the client that set the current * ackState, if any.

Definition at line 75 of file IVxEvent.h.

VxAckState::Value VxSdk::IVxEvent::ackState

The current acknowledgement state of the event.

Definition at line 132 of file IVxEvent.h.

char VxSdk::IVxEvent::ackTime[256]

The time at which the current ackState was set.

Definition at line 79 of file IVxEvent.h.

char VxSdk::IVxEvent::ackUser[256]

The user that set the current ackState, if any.

Definition at line 83 of file IVxEvent.h.

char VxSdk::IVxEvent::generatorDeviceId[64]

The unique identifier of the device that created and injected this event into the system.

Definition at line 88 of file IVxEvent.h.

char VxSdk::IVxEvent::generatorDeviceName[256]

The friendly name of the generator device, if any.

Definition at line 92 of file IVxEvent.h.

char VxSdk::IVxEvent::id[64]

The unique identifier created by the device that generated the event.

Definition at line 96 of file IVxEvent.h.

bool VxSdk::IVxEvent::isInitial

Indicates whether the event is in its initial generated state (its ackState has not been updated).

Definition at line 67 of file IVxEvent.h.

VxKvObject** VxSdk::IVxEvent::properties

Optional additional information related to the event.

Definition at line 136 of file IVxEvent.h.

int VxSdk::IVxEvent::propertySize

The size of properties.

Definition at line 124 of file IVxEvent.h.

unsigned short VxSdk::IVxEvent::severity

The severity of the event, from 1 (highest) to 10 (lowest).

Definition at line 128 of file IVxEvent.h.

char VxSdk::IVxEvent::situationType[256]

The type of the situation that led to the generation of this event.

Definition at line 100 of file IVxEvent.h.

char VxSdk::IVxEvent::sourceClientId[64]

The client identifier of the client that was the cause of the situation, if any.

Definition at line 104 of file IVxEvent.h.

char VxSdk::IVxEvent::sourceDeviceId[64]

The unique identifier of the device that the situation occurred on.

Definition at line 108 of file IVxEvent.h.

char VxSdk::IVxEvent::sourceDeviceName[256]

The friendly name of the source device.

Definition at line 112 of file IVxEvent.h.

char VxSdk::IVxEvent::sourceUserName[64]

The name of the user that was the cause of the situation, if any.

Definition at line 116 of file IVxEvent.h.

char VxSdk::IVxEvent::time[64]

The time at which the situation occurred.

Definition at line 120 of file IVxEvent.h.

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