CppSamples::Exports::ViewExport Class Reference

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

#include <ViewExport.h>

Public Member Functions
	ViewExport (const std::string description)
	~ViewExport ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Print all exports available 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...

Static Protected Member Functions
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 print all exports available in the current system.

Definition at line 12 of file ViewExport.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 14 of file ViewExport.h.

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

CppSamples::Exports::ViewExport::~ViewExport ( )

inline

Definition at line 15 of file ViewExport.h.

{ }

Member Function Documentation

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

staticprotected

Prints the given collection of exports to the screen.

Parameters

exportCollection

Collection of exports.

Definition at line 29 of file ViewExport.cpp.

                                                                                                         {
    cout << 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];
        VxExportStatus::Value expStatus = vxExport->status;

        // Status to string value
        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::ViewExport::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 70 of file ViewExport.cpp.

                                                                                     {
    cout << "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::ViewExport::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Print all exports available in the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 10 of file ViewExport.cpp.

                                                             {
    Utility::ClearScreen();

    // Get a collection of exports from the system
    VxCollection<IVxExport**> exportCollection = GetExports(dataModel->VxSystem);
    // Display the details of exports in the collection on screen.
    DisplayExportDetailsOnScreen(exportCollection);

    cout << "\n\n";
    // Pause for user input before going back to parent menu.
    Utility::Pause();

    // Remove the memory allocated to the collection.
    delete[] exportCollection.collection;
    // 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/ViewExport.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Exports/ViewExport.cpp