CppSamples::Exports::DeleteExport Class Reference

This plugin sample deletes an export from the current system. More...

#include <DeleteExport.h>

Public Member Functions
	DeleteExport (const std::string description)
	~DeleteExport ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Deletes an export 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...

Static Protected Member Functions
static void	DeleteSingleExport (VxSdk::IVxSystem *vxSystem)
	Deletes an export from the current system. More...
static void	DisplayExportDetailsOnScreen (VxSdk::VxCollection< VxSdk::IVxExport ** > exportCollection)
	Prints the given collection of exports to the screen. More...
static VxSdk::VxCollection< VxSdk::IVxExport ** >	GetExports (VxSdk::IVxSystem *vxSystem)
	Get a collection of exports from the given VideoExpert system. More...

Detailed Description

This plugin sample deletes an export from the current system.

Definition at line 12 of file DeleteExport.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Exports::DeleteExport::DeleteExport ( const std::string  description )

inline

Definition at line 14 of file DeleteExport.h.

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

CppSamples::Exports::DeleteExport::~DeleteExport ( )

inline

Definition at line 15 of file DeleteExport.h.

{ }

Member Function Documentation

void CppSamples::Exports::DeleteExport::DeleteSingleExport ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Deletes an export from the current system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Definition at line 22 of file DeleteExport.cpp.

                                                                          {
    // Get all exports from the system
    VxCollection<IVxExport**> exports = GetExports(vxSystem);
    DisplayExportDetailsOnScreen(exports);

    // Validate Collection
    if (exports.collectionSize <= 0)
        return;

    // User selects an export
    cout << "\n" << "Enter index of export to delete [1-" << exports.collectionSize << "] : ";
    int exportIndex = Utility::ReadInt();

    // Validate user input
    if (exportIndex < 1 || exportIndex > exports.collectionSize)
        return;

    // Print details of selected export to delete
    IVxExport* vxExport = exports.collection[exportIndex - 1];
    cout << "\n" << "Name of the export you selected for delete : " << vxExport->name;

    // Delete the export
    VxResult::Value result = vxExport->DeleteExport();
    if (result == VxResult::kOK)
        cout << "\n" << "Export deleted succesfully.\n";
    else
        cout << "\n" << "Failed to delete export!!\n";

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

void CppSamples::Exports::DeleteExport::DisplayExportDetailsOnScreen ( VxSdk::VxCollection< VxSdk::IVxExport ** >  exportCollection )

staticprotected

Prints the given collection of exports to the screen.

Parameters

exportCollection

Collection of exports.

Definition at line 55 of file DeleteExport.cpp.

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

    // Header Line
    cout << "\n-----------------------------------------------------------------";
    for (int i = 0; i < exportCollection.collectionSize; i++) {
        IVxExport* vxExport = exportCollection.collection[i];

        // Status to string value
        VxExportStatus::Value expStatus = vxExport->status;
        string expStatusInString = "U";
        switch (expStatus) {
        case VxExportStatus::Value::kExporting:
            expStatusInString = "E";
            break;
        case VxExportStatus::Value::kSuccessful:
            expStatusInString = "S";
            break;
        case VxExportStatus::Value::kFailed:
            expStatusInString = "F";
            break;
        case VxExportStatus::Value::kPending:
            expStatusInString = "P";
            break;
        case VxExportStatus::Value::kUnknown:
        default:
            break;
        }
        // Print details of single export
        cout << "\n\t" << (i + 1) << "\t" << vxExport->name << "\t" << expStatusInString;
    }

    // Footer
    cout << "\n-----------------------------------------------------------------";
    cout << "\n  Status: E-Exporting  S-Successful  F-Failed  P-Pending  U-Unknown\n";
}

VxCollection< IVxExport ** > CppSamples::Exports::DeleteExport::GetExports ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of exports from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of exports.

Definition at line 95 of file DeleteExport.cpp.

                                                                                       {
    cout << "\n\n" << "Fetching exports from system. Please wait...\n";
    // Read the size of collection from system.
    VxCollection<IVxExport**> exports;
    VxResult::Value result = vxSystem->GetExports(exports);
    if (result == VxResult::kInsufficientSize) {
        // Allocate memory for the requried collection.
        exports.collection = new IVxExport*[exports.collectionSize];
        // Read the collection from system.
        vxSystem->GetExports(exports);
    }

    return exports;
}

Plugin * CppSamples::Exports::DeleteExport::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Deletes an export from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 10 of file DeleteExport.cpp.

                                                               {
    DeleteSingleExport(dataModel->VxSystem);

    cout << "\n\n";
    // Pause for user input 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/Exports/DeleteExport.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Exports/DeleteExport.cpp