This plugin sample print all available situations in the current system. More...

#include <DisplaySituations.h>

Public Member Functions
	DisplaySituations (const std::string description)

	~DisplaySituations ()

CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Print all available situations in the current system. 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	Display (VxSdk::IVxSystem *vxSystem)
	Print all available situations in the current system. More...

VxSdk::VxCollection< VxSdk::IVxSituation ** >	GetSituations (VxSdk::IVxSystem *vxSystem)
	Get a collection of situations from the given VideoExpert system. More...

void	DisplaySituationDetailsOnScreen (VxSdk::VxCollection< VxSdk::IVxSituation ** > situations)
	Print the given collection of situations on screen More...

Detailed Description

This plugin sample print all available situations in the current system.

Definition at line 12 of file DisplaySituations.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 14 of file DisplaySituations.h.

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

CppSamples::Common::Plugin

Plugin is the abstract class which can be a menu item and/or a sample. Every sample and menu item mus...

Definition: Plugin.h:33

CppSamples::Events::DisplaySituations::~DisplaySituations ( )

inline

Definition at line 15 of file DisplaySituations.h.

15 {}

Member Function Documentation

void CppSamples::Events::DisplaySituations::Display ( VxSdk::IVxSystem * vxSystem )

private

Print all available situations in the current system.

Menu function for displaying situations available in a system

Parameters

vxSystem Pointer to the VideoExpert system.

Parameters

vxSystem system pointer

Definition at line 26 of file DisplaySituations.cpp.

                                                                    {
 
     cout << "\n\n" << "Fetching situations from system..Please wait..\n";
     VxCollection<IVxSituation**> situations = GetSituations(vxSystem);
     DisplaySituationDetailsOnScreen(situations);
 
     // Remove the memory allocated to the collection.
     delete[] situations.collection;
 }

void CppSamples::Events::DisplaySituations::DisplaySituationDetailsOnScreen ( VxSdk::VxCollection< VxSdk::IVxSituation ** > situations )

private

Print the given collection of situations on screen

Method for displaying situation details

Parameters

situations Collection of Situations to be printed.

Parameters

situations Situations list to iterate

Definition at line 56 of file DisplaySituations.cpp.

                                                                                                                {
 
     if (situations.collectionSize > 0) {
         cout << situations.collectionSize << " situations found.\n";
 
         // Print Heading
         cout << "\n\n";
         cout << setfill(' ') << "  INDEX         " << setw(60) << left << "  TYPE" << "\n";
         cout << "\n--------------------------------------------------\n";
 
         // Print Situation Details
         int index = 0;
         for (int i = 0; i < situations.collectionSize;i++) {
             IVxSituation* situation = situations.collection[i];
             cout << setfill(' ') << "\n\t" << index + 1 << "\t" << left << setw(60) << left << situation->type;
             index++;
         }
         // Print Footer
         cout << "\n--------------------------------------------------\n";
     }
     else
         cout << "No situations found!!\n";
 }

VxCollection< IVxSituation ** > CppSamples::Events::DisplaySituations::GetSituations ( VxSdk::IVxSystem * vxSystem )

private

Get a collection of situations from the given VideoExpert system.

Parameters

vxSystem Pointer to the VideoExpert system.

Returns: A collection of situations.

Definition at line 37 of file DisplaySituations.cpp.

                                                                                                  {
 
     // Read the size of collection from system.
     VxCollection<IVxSituation**> situations;
     VxResult::Value result = vxSystem->GetSituations(situations);
     if (result == VxResult::kInsufficientSize) {
         // Allocate memory for the requried collection.
         situations.collection = new IVxSituation*[situations.collectionSize];
         // Read the collection from system.
         result = vxSystem->GetSituations(situations);
     }
 
     return situations;
 }

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

overridevirtual

Print all available situations in the current system.

Parameters

dataModel Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 10 of file DisplaySituations.cpp.

                                                                    {
 
     Display(dataModel->VxSystem);
 
     // Pause for user input before going back to parent menu.
     // 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();
 }

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

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

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation