CppSamples::Events::MonitorEvents Class Reference

This plugin sample shows how to subscribe for a notification, monitor for a call back and unsubscribe that. More...

#include <MonitorEvents.h>

Public Member Functions
	MonitorEvents (const std::string description)
	~MonitorEvents ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Subscribe for a notification, monitor for a call back and unsubscribe that. More...
Public Member Functions inherited from CppSamples::Common::Plugin
	Plugin (const std::string description)
virtual	~Plugin ()
std::string	GetDescription () const
	Gets the description of this plugin. More...
Plugin *	GetParent () const
	Gets the reference to the parent of this plugin. More...
void	SetParent (Plugin *parent)
	Sets the reference to the parent of this plugin. More...

Private Member Functions
void	StartMonitorEvents (VxSdk::IVxSystem *vxSystem)
	Subscribe for a notification, monitor for a call back and unsubscribe that. More...
void	PrintEventHeadings ()
	Print the headings for a table of events. More...
bool	SubscribeEvents (VxSdk::IVxSystem *vxSystem)
	Subscribe to event notifications More...
bool	UnSubscribeEvents (VxSdk::IVxSystem *vxSystem)
	Unsubscribe to event notifications More...

Static Private Member Functions
static void	PrintEventRow (VxSdk::IVxEvent *vxEvent)
	Print the details of the given event in a line. More...
static void	EventsCallBack (VxSdk::IVxEvent *vxEvent)
	Callback method to handle events received from VxSDK More...

Detailed Description

This plugin sample shows how to subscribe for a notification, monitor for a call back and unsubscribe that.

Definition at line 12 of file MonitorEvents.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Events::MonitorEvents::MonitorEvents ( const std::string  description )

inline

Definition at line 14 of file MonitorEvents.h.

: CppSamples::Common::Plugin(description) { }

CppSamples::Events::MonitorEvents::~MonitorEvents ( )

inline

Definition at line 15 of file MonitorEvents.h.

{}

Member Function Documentation

void CppSamples::Events::MonitorEvents::EventsCallBack ( VxSdk::IVxEvent *  vxEvent )

staticprivate

Callback method to handle events received from VxSDK

Parameters

vxEvent

Pointer to the event containing newly received event details.

Parameters

vxEvent

IVxEvent pointer containing newly received event details

Definition at line 73 of file MonitorEvents.cpp.

                                                                    {
    // Only log acknowledgement needed events. Skip others
    if (vxEvent->ackState != VxAckState::kAutoAcked)
        PrintEventRow(vxEvent);
}

void CppSamples::Events::MonitorEvents::PrintEventHeadings ( )

private

Print the headings for a table of events.

Display the headings for a table of events

Definition at line 59 of file MonitorEvents.cpp.

                                                       {
    const int eventTimeWidth = 20;
    const int eventStringWidth = 32;
    cout << "\n--------------------------------------------------\n";
    cout << left << setw(eventTimeWidth) << setfill(' ') << "Time(UTC)";
    cout << left << setw(eventStringWidth) << setfill(' ') << "Situation Type";
    cout << left << setw(eventStringWidth) << setfill(' ') << "Source Device";
    cout << "\n--------------------------------------------------\n";
}

void CppSamples::Events::MonitorEvents::PrintEventRow ( VxSdk::IVxEvent *  vxEvent )

staticprivate

Print the details of the given event in a line.

Display a row of event details

Parameters

vxEvent

Pointer to the event to display

Parameters

vxEvent

CPPConsole::Event pointer containing the event to display

Definition at line 47 of file MonitorEvents.cpp.

                                                                   {
    const int eventTimeWidth = 20;
    const int eventStringWidth = 32;
    cout << left << setw(eventTimeWidth) << setfill(' ') << Utility::ConvertUTCTimeFormatToString(vxEvent->time);
    cout << left << setw(eventStringWidth) << setfill(' ') << vxEvent->situationType;
    cout << left << setw(eventStringWidth) << setfill(' ') << vxEvent->sourceDeviceId;
    cout << "\n";
}

Plugin * CppSamples::Events::MonitorEvents::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Subscribe for a notification, monitor for a call back and unsubscribe that.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 10 of file MonitorEvents.cpp.

                                                               {

    StartMonitorEvents(dataModel->VxSystem);

    // Return reference of parent plugin to move back to parent menu.
    return GetParent();
}

void CppSamples::Events::MonitorEvents::StartMonitorEvents ( VxSdk::IVxSystem *  vxSystem )

private

Subscribe for a notification, monitor for a call back and unsubscribe that.

Parameters

vxSystem

Pointer to the VideoExpert system.

Definition at line 18 of file MonitorEvents.cpp.

                                                                          {

    cout << "\n\n" << "Subscribing to events";
    if (!SubscribeEvents(vxSystem)) {
        cout << "Error subscribing to events! \n";

        // Wait for user response before going back to parent menu.
        Utility::Pause();

        return;
    }

    cout << "Monitoring events. Press any key to stop . . .\n\n";
    PrintEventHeadings();
    cin.ignore(256, '\n');
    cin.get();
    cout << "Unsubscribing to events";
    if (!UnSubscribeEvents(vxSystem))
        cout << "Error unsubscribing to events!\n";

    cout << "\n";
    // Wait for user response before going back to parent menu.
    Utility::Pause();
}

bool CppSamples::Events::MonitorEvents::SubscribeEvents ( VxSdk::IVxSystem *  vxSystem )

private

Subscribe to event notifications

Parameters

vxSystem

Pointer to the VideoExpert system.

Parameters

vxSystem

system pointer

Definition at line 83 of file MonitorEvents.cpp.

                                                                       {

    VxResult::Value result = vxSystem->StartNotifications(&MonitorEvents::EventsCallBack);
    if (result == VxResult::kOK) {
        cout << "\n" << "Events subscription successful.\n";
        return true;
    }
    else {
        cout << "\n" << "Failed to subscribe events!!\n";
        return false;
    }
}

bool CppSamples::Events::MonitorEvents::UnSubscribeEvents ( VxSdk::IVxSystem *  vxSystem )

private

Unsubscribe to event notifications

Parameters

vxSystem

Pointer to the VideoExpert system.

Parameters

vxSystem

system pointer

Definition at line 100 of file MonitorEvents.cpp.

                                                                         {

    VxResult::Value result = vxSystem->StopNotifications();
    if (result == VxResult::kOK) {
        cout << "\n" << "Events unsubscription successful.\n";
        return true;
    }
    else {
        cout << "\n" << "Failed to unsubscribe events!!\n";
        return false;
    }
}

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Events/MonitorEvents.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Events/MonitorEvents.cpp