CppSamples::Events::DeleteSituation Class Reference

This plugin sample delete a particular situation specified by user from the current system. More...

#include <DeleteSituation.h>

Public Member Functions
	DeleteSituation (const std::string description)
	~DeleteSituation ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Delete a particular situation specified by user from 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	Delete (VxSdk::IVxSystem *vxSystem)
	Delete a particular situation specified by user from 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 delete a particular situation specified by user from the current system.

Definition at line 12 of file DeleteSituation.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 14 of file DeleteSituation.h.

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

CppSamples::Events::DeleteSituation::~DeleteSituation ( )

inline

Definition at line 15 of file DeleteSituation.h.

{}

Member Function Documentation

void CppSamples::Events::DeleteSituation::Delete ( VxSdk::IVxSystem *  vxSystem )

private

Delete a particular situation specified by user from the current system.

Menu function for deleting situation from server

Parameters

vxSystem

Pointer to the VideoExpert system.

Parameters

vxSystem

system pointer

Definition at line 26 of file DeleteSituation.cpp.

                                                                {
    // Get all situations from the system
    cout << "\n" << "Fetching situations from system..Please wait..\n";
    VxCollection<IVxSituation**> situations = GetSituations(vxSystem);
    DisplaySituationDetailsOnScreen(situations);

    // User selects a situation
    cout << "\n" << "Enter the index of situation to delete [1-" << situations.collectionSize << "] : ";
    int situationToDelete = Utility::ReadInt();

    // Validate user input
    if (situationToDelete < 1 || situationToDelete > situations.collectionSize)
        return;

    // Print details of selected situation to delete
    IVxSituation* situation = situations.collection[situationToDelete - 1];
    cout << "\n" << "Situation selected for delete is:" << situation->type << "\n";

    // Delete the situation
    VxResult::Value result = situation->DeleteSituation();
    if (result == VxResult::kOK)
        cout << "\n" << "Situation deleted succesfully.\n";
    else
        cout << "\n" << "Failed to delete situation.\n";

    // Remove the memory allocated to the collection.
    delete[] situations.collection;
}

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

private

Print the given collection of situations on screen.

Parameters

situations

Collection of Situations to be printed.

Parameters

situations

Situations list to iterate

Definition at line 74 of file DeleteSituation.cpp.

                                                                                                             {
    if (situations.collectionSize > 0) {
        cout << situations.collectionSize << " situations found.\n";

        cout << "\n\n";
        cout << setfill(' ') << "  INDEX         " << setw(60) << left << "  TYPE" << "\n";
        cout << "\n--------------------------------------------------\n";

        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++;
        }
        cout << "\n--------------------------------------------------\n";
    }
    else
        cout << "No situations found!!\n";
}

VxCollection< IVxSituation ** > CppSamples::Events::DeleteSituation::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 56 of file DeleteSituation.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::DeleteSituation::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Delete a particular situation specified by user from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 11 of file DeleteSituation.cpp.

                                                                 {
    Delete(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/DeleteSituation.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Events/DeleteSituation.cpp