VxSdk::VxInternalEvent Struct Reference

Represents an internal event generated by the VxSDK. More...

#include <VxInternalEvent.h>

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

Public Attributes
char	id [64]
	The unique identifier of the event. More...
VxInternalEventType::Value	eventType
	The internal event type. More...
int	propertySize
	The size of properties. More...
VxKvObject *	properties
	Optional additional information related to the event. More...

Detailed Description

Represents an internal event generated by the VxSDK.

Definition at line 13 of file VxInternalEvent.h.

Constructor & Destructor Documentation

VxSdk::VxInternalEvent::VxInternalEvent ( )

inline

Initializes a new instance of the VxInternalEvent struct.

Definition at line 18 of file VxInternalEvent.h.

                          {
            Clear();
        }

VxSdk::VxInternalEvent::VxInternalEvent ( const VxInternalEvent &  ref )

inline

Initializes a new instance of the VxInternalEvent struct.

Parameters

ref	The reference.

Definition at line 26 of file VxInternalEvent.h.

                                                    {
            Utilities::StrCopySafe(this->id, ref.id);
            this->eventType = ref.eventType;
            this->propertySize = ref.propertySize;
            this->properties = ref.properties;
        }

VxSdk::VxInternalEvent::~VxInternalEvent ( )

inline

Finalizes an instance of the VxInternalEvent class.

Definition at line 36 of file VxInternalEvent.h.

                           {
            Clear();
        }

Member Function Documentation

void VxSdk::VxInternalEvent::Clear ( )

inline

Clears this instance.

Definition at line 43 of file VxInternalEvent.h.

                     {
            VxZeroArray(this->id);
            this->eventType = VxInternalEventType::kUnknown;
            this->propertySize = 0;
            this->properties = nullptr;
        }

Member Data Documentation

VxInternalEventType::Value VxSdk::VxInternalEvent::eventType

The internal event type.

Definition at line 58 of file VxInternalEvent.h.

char VxSdk::VxInternalEvent::id[64]

The unique identifier of the event.

Definition at line 54 of file VxInternalEvent.h.

VxKvObject* VxSdk::VxInternalEvent::properties

Optional additional information related to the event.

Definition at line 66 of file VxInternalEvent.h.

int VxSdk::VxInternalEvent::propertySize

The size of properties.

Definition at line 62 of file VxInternalEvent.h.

---

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

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