CppSamples::Roles::ViewAllRoles Class Reference

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

#include <ViewAllRoles.h>

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

Detailed Description

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

Definition at line 12 of file ViewAllRoles.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Roles::ViewAllRoles::ViewAllRoles ( const std::string  description )

inline

Definition at line 14 of file ViewAllRoles.h.

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

CppSamples::Roles::ViewAllRoles::~ViewAllRoles ( )

inline

Definition at line 15 of file ViewAllRoles.h.

{ }

Member Function Documentation

VxCollection< IVxRole ** > CppSamples::Roles::ViewAllRoles::GetRoles ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of roles from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of roles.

Definition at line 33 of file ViewAllRoles.cpp.

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

void CppSamples::Roles::ViewAllRoles::PrintRoles ( VxSdk::VxCollection< VxSdk::IVxRole ** >  roleCollection )

staticprotected

Prints the given collection of roles to the screen.

Parameters

roleCollection

Collection of roles.

Definition at line 47 of file ViewAllRoles.cpp.

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

    cout << "---------------------------------------------------------------------------------------------";
    for (int i = 0; i < roleCollection.collectionSize; i++) {
        IVxRole* role = roleCollection.collection[i];

        cout << "\n" << (i + 1);
        cout << "\t" << role->id;
        cout << "\t" << role->name;
    }
    cout << "\n---------------------------------------------------------------------------------------------\n";
}

Plugin * CppSamples::Roles::ViewAllRoles::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Print all roles available in the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file ViewAllRoles.cpp.

                                                             {
    Utility::ClearScreen();

    VxCollection<IVxRole**> roles = GetRoles(dataModel->VxSystem);
    PrintRoles(roles);

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

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