CppSamples::Notifications::ViewAllNotifications Class Reference

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

#include <ViewAllNotifications.h>

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

Detailed Description

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

Definition at line 12 of file ViewAllNotifications.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Notifications::ViewAllNotifications::ViewAllNotifications ( const std::string  description )

inline

Definition at line 14 of file ViewAllNotifications.h.

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

CppSamples::Notifications::ViewAllNotifications::~ViewAllNotifications ( )

inline

Definition at line 15 of file ViewAllNotifications.h.

{ }

Member Function Documentation

VxCollection< IVxNotification ** > CppSamples::Notifications::ViewAllNotifications::GetNotifications ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of notifications from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of notifications.

Definition at line 33 of file ViewAllNotifications.cpp.

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

void CppSamples::Notifications::ViewAllNotifications::PrintNotifications ( VxSdk::VxCollection< VxSdk::IVxNotification ** >  notificationCollection )

staticprotected

Prints the given collection of notifications to the screen.

Parameters

notificationCollection

Collection of notifications.

Definition at line 47 of file ViewAllNotifications.cpp.

                                                                                                                           {

    cout << notificationCollection.collectionSize << " notifications found." << "\n";
    if (notificationCollection.collectionSize == 0)
        return;

    cout << "---------------------------------------------------------------------------------------------";
    for (int i = 0; i < notificationCollection.collectionSize; i++) {
        IVxNotification* notification = notificationCollection.collection[i];

        cout << "\n" << (i + 1);
        cout << "\t" << notification->id;

        VxCollection<IVxRole**> roles;
        VxResult::Value result = notification->GetRoles(roles);
        if (result == VxResult::kInsufficientSize) {
            roles.collection = new IVxRole*[roles.collectionSize];
            notification->GetRoles(roles);
        }
        cout << "\t" << roles.collectionSize << " role(s) associated with this.";
        for (int j = 0; j < roles.collectionSize; j++)
            cout << "\n\t\t" << (i + 1) << "." << (j + 1) << "\t" << roles.collection[j]->name;
    }
    cout << "\n---------------------------------------------------------------------------------------------\n";
}

Plugin * CppSamples::Notifications::ViewAllNotifications::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Print all notifications available in the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file ViewAllNotifications.cpp.

                                                                             {
    Utility::ClearScreen();

    VxCollection<IVxNotification**> notifications = GetNotifications(dataModel->VxSystem);
    PrintNotifications(notifications);

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

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