VxSdk::VxNewEvent Struct Reference

Represents a request for a new event to be generated. The event will be generated based upon the event data, its situation configuration, and will receive a unique identifier. More...

#include <VxNewEvent.h>

Public Member Functions
	VxNewEvent ()
	Initializes a new instance of the VxNewEvent struct. More...
	VxNewEvent (const VxNewEvent &ref)
	Initializes a new instance of the VxNewEvent struct. More...
	~VxNewEvent ()
	Finalizes an instance of the VxNewEvent class. More...
void	Clear ()
	Clears this instance. More...

Public Attributes
char	generatorDeviceId [64]
	The unique identifier of the device that generated this event. More...
char	id [64]
	The unique identifier of the event. If not provided, the server will create this value. More...
char	situationType [64]
	The identifier for the type of situation that led to this new event. More...
char	sourceDeviceId [64]
	The unique identifier of the device that the situation occurred on. More...
char	sourceUserName [64]
	The unique identifier of the user that caused the situation to occur. More...
char	time [64]
	The time at which the situation occurred. More...
int	propertySize
	The size of properties. More...
VxKvObject *	properties
	Optional additional information related to the event. More...

Detailed Description

Represents a request for a new event to be generated. The event will be generated based upon the event data, its situation configuration, and will receive a unique identifier.

Definition at line 14 of file VxNewEvent.h.

Constructor & Destructor Documentation

VxSdk::VxNewEvent::VxNewEvent ( )

inline

Initializes a new instance of the VxNewEvent struct.

Definition at line 19 of file VxNewEvent.h.

                     {
            Clear();
        }

VxSdk::VxNewEvent::VxNewEvent ( const VxNewEvent &  ref )

inline

Initializes a new instance of the VxNewEvent struct.

Parameters

ref	The reference.

Definition at line 27 of file VxNewEvent.h.

                                          {
            Utilities::StrCopySafe(this->generatorDeviceId, ref.generatorDeviceId);
            Utilities::StrCopySafe(this->id, ref.id);
            Utilities::StrCopySafe(this->situationType, ref.situationType);
            Utilities::StrCopySafe(this->sourceDeviceId, ref.sourceDeviceId);
            Utilities::StrCopySafe(this->sourceUserName, ref.sourceUserName);
            Utilities::StrCopySafe(this->time, ref.time);
            this->propertySize = ref.propertySize;
            this->properties = ref.properties;
        }

VxSdk::VxNewEvent::~VxNewEvent ( )

inline

Finalizes an instance of the VxNewEvent class.

Definition at line 41 of file VxNewEvent.h.

                      {
            Clear();
        }

Member Function Documentation

void VxSdk::VxNewEvent::Clear ( )

inline

Clears this instance.

Definition at line 48 of file VxNewEvent.h.

                     {
            VxZeroArray(this->generatorDeviceId);
            VxZeroArray(this->id);
            VxZeroArray(this->situationType);
            VxZeroArray(this->sourceDeviceId);
            VxZeroArray(this->sourceUserName);
            VxZeroArray(this->time);
            this->propertySize = 0;
            this->properties = nullptr;
        }

Member Data Documentation

char VxSdk::VxNewEvent::generatorDeviceId[64]

The unique identifier of the device that generated this event.

Definition at line 63 of file VxNewEvent.h.

char VxSdk::VxNewEvent::id[64]

The unique identifier of the event. If not provided, the server will create this value.

Definition at line 67 of file VxNewEvent.h.

VxKvObject* VxSdk::VxNewEvent::properties

Optional additional information related to the event.

Definition at line 91 of file VxNewEvent.h.

int VxSdk::VxNewEvent::propertySize

The size of properties.

Definition at line 87 of file VxNewEvent.h.

char VxSdk::VxNewEvent::situationType[64]

The identifier for the type of situation that led to this new event.

Definition at line 71 of file VxNewEvent.h.

char VxSdk::VxNewEvent::sourceDeviceId[64]

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

Definition at line 75 of file VxNewEvent.h.

char VxSdk::VxNewEvent::sourceUserName[64]

The unique identifier of the user that caused the situation to occur.

Definition at line 79 of file VxNewEvent.h.

char VxSdk::VxNewEvent::time[64]

The time at which the situation occurred.

Definition at line 83 of file VxNewEvent.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/VxNewEvent.h