C++/CLI Sample
Demonstrates how to create a C++/CLI library using the VideoXpert SDK
CPPCli::InternalEvent Class Reference

The InternalEvent class represents an internal event generated by the VxSDK. More...

#include <InternalEvent.h>

Public Types

enum  EventType {
  EventType::Unknown,
  EventType::SystemConnectionLost,
  EventType::SystemConnectionRestored
}
 Values that represent event types sent from the VxSDK. More...
 

Public Member Functions

 InternalEvent ()
 Default constructor. More...
 
 InternalEvent (VxSdk::VxInternalEvent *vxInternalEvent)
 Constructor. More...
 

Package Attributes

VxSdk::VxInternalEvent_internalEvent
 

Properties

System::String^  Id [get]
 Gets the unique identifier of the event. More...
 
System::Collections::Generic::List< System::Collections::Generic::KeyValuePair< System::String^ , System::String^ >>^ Properties [get]
 Gets any additional information related to the event. More...
 
EventType Type [get]
 Gets the internal event type. More...
 

Detailed Description

The InternalEvent class represents an internal event generated by the VxSDK.

Definition at line 12 of file InternalEvent.h.

Member Enumeration Documentation

Values that represent event types sent from the VxSDK.

Enumerator
Unknown 

An error or unknown value was returned.

SystemConnectionLost 

The connection to the VideoXpert system was lost.

SystemConnectionRestored 

The connection to the VideoXpert system was restored.

Definition at line 18 of file InternalEvent.h.

18  {
20  Unknown,
21 
23  SystemConnectionLost,
24 
26  SystemConnectionRestored
27  };

Constructor & Destructor Documentation

CPPCli::InternalEvent::InternalEvent ( )
inline

Default constructor.

Definition at line 32 of file InternalEvent.h.

32  {
34  }
VxSdk::VxInternalEvent * _internalEvent
Definition: InternalEvent.h:83
CPPCli::InternalEvent::InternalEvent ( VxSdk::VxInternalEvent vxInternalEvent)
inline

Constructor.

Parameters
vxInternalEventThe internal event.

Definition at line 40 of file InternalEvent.h.

40 : _internalEvent(vxInternalEvent) {};
VxSdk::VxInternalEvent * _internalEvent
Definition: InternalEvent.h:83

Member Data Documentation

VxSdk::VxInternalEvent* CPPCli::InternalEvent::_internalEvent
package

Definition at line 83 of file InternalEvent.h.

Property Documentation

System:: String^ CPPCli::InternalEvent::Id
get

Gets the unique identifier of the event.

The unique identifier.

Definition at line 46 of file InternalEvent.h.

System:: Collections:: Generic:: List< System:: Collections:: Generic:: KeyValuePair< System:: String^, System:: String^>>^ CPPCli::InternalEvent::Properties
get

Gets any additional information related to the event.

A List containing the event properties.

Definition at line 55 of file InternalEvent.h.

EventType CPPCli::InternalEvent::Type
get

Gets the internal event type.

The type identifier of the event.

Definition at line 77 of file InternalEvent.h.


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