CppSamples::Notifications::AddNotification Class Reference

This plugin sample adds a notification to the current system. More...

#include <AddNotification.h>

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

Private Member Functions
std::vector< std::string >	GetSelectedRoles (VxSdk::IVxSystem *vxSystem)
	Get a list of selected roles from the given VideoExpert system. More...
VxSdk::VxCollection< VxSdk::IVxRole ** >	GetRoles (VxSdk::IVxSystem *vxSystem)
	Get a collection of roles from the given VideoExpert system. More...

Detailed Description

This plugin sample adds a notification to the current system.

Definition at line 14 of file AddNotification.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 16 of file AddNotification.h.

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

CppSamples::Notifications::AddNotification::~AddNotification ( )

inline

Definition at line 17 of file AddNotification.h.

{}

Member Function Documentation

VxCollection< IVxRole ** > CppSamples::Notifications::AddNotification::GetRoles ( VxSdk::IVxSystem *  vxSystem )

private

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 79 of file AddNotification.cpp.

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

vector< string > CppSamples::Notifications::AddNotification::GetSelectedRoles ( VxSdk::IVxSystem *  vxSystem )

private

Get a list of selected roles from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A list of selected roles.

Definition at line 51 of file AddNotification.cpp.

                                                                                           {

    vector<string> selectedRoles;

    VxCollection<IVxRole**> allRoles = GetRoles(vxSystem);
    for (int i = 0; i < allRoles.collectionSize; i++) {
        IVxRole* role = allRoles.collection[i];

        if (role->isReadOnly && (strcmp(role->name, "administrator") != 0))
            continue;

        cout << "\n" << "Select role (" << role->name<< ") y/n : ";
        string option = Utility::ReadString();
        if (option.size() > 0 && (option[0] == 'y' || option[0] == 'Y')) {
            selectedRoles.push_back(string(role->id));
            cout << role->name << " is selected. \n";
        }
        else
            cout << role->name << " is NOT selected. \n";
    }
    return selectedRoles;
}

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

overridevirtual

Adds a notification to the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 14 of file AddNotification.cpp.

                                                                        {
    // Get a list of selected roles from the system
    vector<string> roleIds = GetSelectedRoles(dataModel->VxSystem);

    // Create a notification object and populate its fields using newNotification
    VxNewNotification vxNotification;
    vxNotification.roleIdSize = static_cast<int>(roleIds.size());
    if (vxNotification.roleIdSize > 0) {
        // Allocate memory for the role Ids.
        vxNotification.roleIds = new char*[vxNotification.roleIdSize];
        for (int i = 0; i < vxNotification.roleIdSize; i++) {
            string roleId = roleIds[i];
            vxNotification.roleIds[i] = new char[roleId.size() + 1];
            Utilities::StrCopySafe(vxNotification.roleIds[i], roleId.c_str(), roleId.size() + 1);
        }
    }

    // Make the call to add the notification into VideoXpert
    IVxNotification* notificationItem = nullptr;
    VxResult::Value result = dataModel->VxSystem->AddNotification(vxNotification, notificationItem);
    if (result == VxResult::kOK)
        cout << "\n" << "Notification added succesfully.\n";
    else
        cout << "\n" << "Failed to add notification.\n";

    // 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();
}

---

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

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