CppSamples::Devices::ViewAllDevices Class Reference

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

#include <ViewAllDevices.h>

Public Member Functions
	ViewAllDevices (const std::string description)
	~ViewAllDevices ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Print all devices 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 VxSdk::VxCollection< VxSdk::IVxDevice ** >	GetDevices (VxSdk::IVxSystem *vxSystem)
	Get a collection of devices from the given VideoExpert system. More...
static void	PrintDevices (VxSdk::VxCollection< VxSdk::IVxDevice ** > deviceCollection)
	Prints the given collection of devices to the screen. More...

Detailed Description

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

Definition at line 12 of file ViewAllDevices.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Devices::ViewAllDevices::ViewAllDevices ( const std::string  description )

inline

Definition at line 14 of file ViewAllDevices.h.

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

CppSamples::Devices::ViewAllDevices::~ViewAllDevices ( )

inline

Definition at line 15 of file ViewAllDevices.h.

{ }

Member Function Documentation

VxCollection< IVxDevice ** > CppSamples::Devices::ViewAllDevices::GetDevices ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of devices from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of devices.

Definition at line 34 of file ViewAllDevices.cpp.

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

void CppSamples::Devices::ViewAllDevices::PrintDevices ( VxSdk::VxCollection< VxSdk::IVxDevice ** >  deviceCollection )

staticprotected

Prints the given collection of devices to the screen.

Parameters

deviceCollection

Collection of devices.

Definition at line 48 of file ViewAllDevices.cpp.

                                                                                             {

    cout << deviceCollection.collectionSize << " devices found." << "\n";
    if (deviceCollection.collectionSize == 0)
        return;

    TabularPrinter tabularPrinter;
    tabularPrinter.AddColumn("No", 5);
    tabularPrinter.AddColumn("Name", 35);
    tabularPrinter.AddColumn("Model", 35);
    tabularPrinter.AddColumn("Status", 8);
    for (int i = 0; i < deviceCollection.collectionSize; i++) {
        IVxDevice* device = deviceCollection.collection[i];

        tabularPrinter.AddRow();
        tabularPrinter.AddCellValue(i + 1);
        tabularPrinter.AddCellValue(device->name);
        tabularPrinter.AddCellValue(device->model);
        tabularPrinter.AddCellValue((device->state == VxDeviceState::kOnline ? "Online " : "Offline"));
    }
    string tableValue = tabularPrinter.ToString();
    cout << tableValue;
}

Plugin * CppSamples::Devices::ViewAllDevices::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Print all devices available in the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 14 of file ViewAllDevices.cpp.

                                                                 {
    Utility::ClearScreen();

    VxCollection<IVxDevice**> devices = GetDevices(dataModel->VxSystem);
    PrintDevices(devices);

    // Wait for user response before going back to parent menu.
    Utility::Pause();

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