CppSamples::DataObjects::DeleteDataObject Class Reference

This plugin sample delete a selected dataObject from the current system. More...

#include <DeleteDataObject.h>

Public Member Functions
	DeleteDataObject (const std::string description)
	~DeleteDataObject ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Delete a selected dataObject 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...

Protected Member Functions
int	SelectDataObjectIndex (VxSdk::VxCollection< VxSdk::IVxDataObject ** > &dataObjects)
	Select a dataObject from the given collection by user input. More...

Static Protected Member Functions
static VxSdk::VxCollection< VxSdk::IVxDataObject ** >	GetDataObjects (VxSdk::IVxSystem *vxSystem)
	Get a collection of dataObjects from the given VideoExpert system. More...
static void	PrintDataObjects (VxSdk::VxCollection< VxSdk::IVxDataObject ** > dataObjectCollection)
	Prints the given collection of dataObjects to the screen. More...

Detailed Description

This plugin sample delete a selected dataObject from the current system.

Definition at line 12 of file DeleteDataObject.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::DataObjects::DeleteDataObject::DeleteDataObject ( const std::string  description )

inline

Definition at line 14 of file DeleteDataObject.h.

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

CppSamples::DataObjects::DeleteDataObject::~DeleteDataObject ( )

inline

Definition at line 15 of file DeleteDataObject.h.

{ }

Member Function Documentation

VxCollection< IVxDataObject ** > CppSamples::DataObjects::DeleteDataObject::GetDataObjects ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of dataObjects from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of dataObjects.

Definition at line 47 of file DeleteDataObject.cpp.

                                                                                                       {
    VxCollection<IVxDataObject**> dataObjects;
    VxResult::Value result = vxSystem->GetDataObjects(dataObjects);
    if (result == VxResult::kInsufficientSize) {
        dataObjects.collection = new IVxDataObject*[dataObjects.collectionSize];
        vxSystem->GetDataObjects(dataObjects);
    }
    return dataObjects;
}

void CppSamples::DataObjects::DeleteDataObject::PrintDataObjects ( VxSdk::VxCollection< VxSdk::IVxDataObject ** >  dataObjectCollection )

staticprotected

Prints the given collection of dataObjects to the screen.

Parameters

dataObjectCollection

Collection of dataObjects.

Definition at line 61 of file DeleteDataObject.cpp.

                                                                                                               {
    cout << dataObjectCollection.collectionSize << " dataObjects found." << "\n";
    if (dataObjectCollection.collectionSize == 0)
        return;

    cout << "---------------------------------------------------------------------------------------------";
    for (int i = 0; i < dataObjectCollection.collectionSize; i++) {
        IVxDataObject* dataObject = dataObjectCollection.collection[i];

        cout << "\n" << (i + 1);
        cout << "\t" << dataObject->id;
        cout << "\t" << dataObject->owner;
        cout << "\t" << dataObject->clientType;
    }
    cout << "\n---------------------------------------------------------------------------------------------\n";
}

Plugin * CppSamples::DataObjects::DeleteDataObject::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Delete a selected dataObject from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file DeleteDataObject.cpp.

                                                                       {
    Utility::ClearScreen();

    // Read and print data objects from the system
    VxCollection<IVxDataObject**> dataObjects = GetDataObjects(dataModel->VxSystem);
    PrintDataObjects(dataObjects);

    if (dataObjects.collectionSize > 0) {
        // Select the data object to delete
        int index = SelectDataObjectIndex(dataObjects);
        if (index >= 0) {
            IVxDataObject* dataObject = dataObjects.collection[index];
            VxResult::Value result = dataObject->DeleteDataObject();
            if (result == VxResult::kOK)
                cout << "\n" << "DataObject deleted succesfully.\n";
            else
                cout << "\n" << "Failed to delete dataObject!!\n";
        }
    }

    // Remove the memory allocated to the collection.
    delete[] dataObjects.collection;
    // 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();
}

int CppSamples::DataObjects::DeleteDataObject::SelectDataObjectIndex ( VxSdk::VxCollection< VxSdk::IVxDataObject ** > &  dataObjects )

protected

Select a dataObject from the given collection by user input.

Parameters

dataObjects

Collection of dataObject.

Returns

Index of the selected dataObject in the given collection.

Definition at line 83 of file DeleteDataObject.cpp.

                                                                                                           {
    while (true) {
        cout << "\n" << "Enter dataObject number [1-" << dataObjects.collectionSize << "] : ";
        int index = Utility::ReadInt();
        if (index == 0)
            break;
        if (index > 0 && index <= dataObjects.collectionSize)
            return index - 1;
        else
            cout << "\n" << "Invalid Option !!!";

        cout << "\n" << "Enter 0 to go back.";
    }

    return -1;
}

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/DataObjects/DeleteDataObject.h
• C:/Git/VxSDK-Samples/CppSamples/Source/DataObjects/DeleteDataObject.cpp