CppSamples::Events::SearchEvents Class Reference

This plugin sample serachs for events in the current system. User defined filters are used for searching. More...

#include <SearchEvents.h>

Public Member Functions
	SearchEvents (const std::string description)
	~SearchEvents ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Serachs for events in the current system. User defined filters are used for searching. 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	DoSearchEvents (VxSdk::IVxSystem *vxSystem)
	Serachs for events in the current system. User defined filters are used for searching. More...
VxSdk::VxCollection< VxSdk::IVxEvent ** >	Search (VxSdk::IVxSystem *vxSystem, std::string startTime, std::string endTime)
	Search for events with the given parameters. More...

Static Private Member Functions
static void	PrintEventRow (VxSdk::IVxEvent *vxEvent)
	Print the details of the given event in a line. More...
static void	PrintEventHeadings ()
	Print the headings for a table of events. More...

Detailed Description

This plugin sample serachs for events in the current system. User defined filters are used for searching.

Definition at line 12 of file SearchEvents.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 14 of file SearchEvents.h.

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

CppSamples::Events::SearchEvents::~SearchEvents ( )

inline

Definition at line 15 of file SearchEvents.h.

{}

Member Function Documentation

void CppSamples::Events::SearchEvents::DoSearchEvents ( VxSdk::IVxSystem *  vxSystem )

private

Serachs for events in the current system. User defined filters are used for searching.

Parameters

vxSystem

Pointer to the VideoExpert system.

Definition at line 23 of file SearchEvents.cpp.

                                                                     {

    // Read Start Time for search
    cout << "\n\n" << "Enter start time for event search (yyyy-mm-dd hh:mm:ss): ";
    struct tm strtTime = Utility::GetDateAndTimeFromUser();
    string startTimeInUTC = Utility::ConvertLocalTimetoUTC(strtTime);

    // End Time for search
    cout << "\n" << "Enter end time for event search (yyyy-mm-dd hh:mm:ss): ";
    struct tm endTime = Utility::GetDateAndTimeFromUser();
    string endTimeInUTC = Utility::ConvertLocalTimetoUTC(endTime);

    // Start Searching Events
    Utility::ClearScreen();

    cout << "Fetching events from " << startTimeInUTC << " to " << endTimeInUTC << " (UTC).";
    cout << "\n\n";
    VxCollection<IVxEvent**> events = Search(vxSystem, startTimeInUTC, endTimeInUTC);
    if (events.collectionSize > 0) {
        if (events.collectionSize < 500) {
            // Print Events
            PrintEventHeadings();
            for (int i = 0; i < events.collectionSize; i++)
                PrintEventRow(events.collection[i]);
        }
        cout << "\n---------------------------------------------------------------------------------------------\n";
        // Remove the memory allocated to the collection.
        delete[] events.collection;
    }

    cout << "\n";
}

void CppSamples::Events::SearchEvents::PrintEventHeadings ( )

staticprivate

Print the headings for a table of events.

Display the headings for a table of events

Definition at line 101 of file SearchEvents.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::SearchEvents::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 89 of file SearchEvents.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::SearchEvents::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Serachs for events in the current system. User defined filters are used for searching.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 11 of file SearchEvents.cpp.

                                                              {

    DoSearchEvents(dataModel->VxSystem);

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

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

VxCollection< IVxEvent ** > CppSamples::Events::SearchEvents::Search ( VxSdk::IVxSystem *  vxSystem, std::string  startTime, std::string  endTime  )

private

Search for events with the given parameters.

Parameters

vxSystem	Pointer to the VideoExpert system.
startTime	Start time for event.
endTime	End time for event.

Returns

A collection of event.

Definition at line 57 of file SearchEvents.cpp.

                                                                                                                   {

    // Create new collection of events to search
    VxCollection<IVxEvent**> events;
    events.filterSize = 2;
    VxCollectionFilter filters[2];
    filters[0].key = VxCollectionFilterItem::kSearchStartTime;
    filters[1].key = VxCollectionFilterItem::kSearchEndTime;
    Utilities::StrCopySafe(filters[0].value, startTime.c_str());
    Utilities::StrCopySafe(filters[1].value, endTime.c_str());
    events.filters = filters;

    // Read the size of collection from system.
    VxResult::Value result = vxSystem->GetEvents(events);
    if (result == VxResult::kInsufficientSize) {
        if (events.collectionSize < 500) {
            // Allocate memory for the requried collection.
            events.collection = new IVxEvent*[events.collectionSize];
            // Read the collection from system.
            vxSystem->GetEvents(events);
        }
        else
            cout << "Found " << events.collectionSize << " events. There are too many to display, please narrow your search.";
    }

    return events;
}

---

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

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