CppSamples::Notifications::DeleteNotification Class Reference

This plugin sample delete a selected notification from the current system. More...

#include <DeleteNotification.h>

Public Member Functions
	DeleteNotification (const std::string description)
	~DeleteNotification ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Delete a selected notification 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...

Protected Member Functions
int	SelectNotificationIndex (VxSdk::VxCollection< VxSdk::IVxNotification ** > &notifications)
	Select a notification from the given collection by user input. 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 delete a selected notification from the current system.

Definition at line 12 of file DeleteNotification.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 14 of file DeleteNotification.h.

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

CppSamples::Notifications::DeleteNotification::~DeleteNotification ( )

inline

Definition at line 15 of file DeleteNotification.h.

{ }

Member Function Documentation

VxCollection< IVxNotification ** > CppSamples::Notifications::DeleteNotification::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 45 of file DeleteNotification.cpp.

                                                                                                               {
    VxCollection<IVxNotification**> notifications;
    // Read the size of collection from system.
    VxResult::Value result = vxSystem->GetNotifications(notifications);
    if (result == VxResult::kInsufficientSize) {
        // Allocate memory for the requried collection.
        notifications.collection = new IVxNotification*[notifications.collectionSize];
        // Read the collection from system.
        vxSystem->GetNotifications(notifications);
    }
    return notifications;
}

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

staticprotected

Prints the given collection of notifications to the screen.

Parameters

notificationCollection

Collection of notifications.

Definition at line 62 of file DeleteNotification.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;

        // Print Role info associated with notification
        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::DeleteNotification::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Delete a selected notification from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file DeleteNotification.cpp.

                                                                           {
    Utility::ClearScreen();

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

    if (notifications.collectionSize > 0) {
        int index = SelectNotificationIndex(notifications);
        if (index >= 0) {
            IVxNotification* notification = notifications.collection[index];
            VxResult::Value result = notification->DeleteNotification();
            if (result == VxResult::kOK)
                cout << "\n" << "Notification deleted succesfully.\n";
            else
                cout << "\n" << "Failed to delete notification!!\n";
        }
    }

    // Remove the memory allocated to the collection.
    delete[] notifications.collection;
    // Wait for user response before going back to parent menu.
    Utility::Pause();

    // Return reference of parent plugin to move back to parent menu.
    return GetParent();
}

int CppSamples::Notifications::DeleteNotification::SelectNotificationIndex ( VxSdk::VxCollection< VxSdk::IVxNotification ** > &  notifications )

protected

Select a notification from the given collection by user input.

Parameters

notifications

Collection of notification.

Returns

Index of the selected notification in the given collection.

Definition at line 94 of file DeleteNotification.cpp.

                                                                                                                     {
    while (true) {
        // Select notification number
        cout << "\n" << "Enter notification number [1-" << notifications.collectionSize << "] : ";
        int index = Utility::ReadInt();
        if (index == 0)
            break;
        // Verify user input
        if (index > 0 && index <= notifications.collectionSize)
            return index - 1;
        else
            cout << "\n" << "Invalid Option !!!";

        cout << "\n" << "Enter 0 to go back.";
    }
    return -1;
}

---

The documentation for this class was generated from the following files:

• C:/Git/VxSDK-Samples/CppSamples/Source/Notifications/DeleteNotification.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Notifications/DeleteNotification.cpp