CppSamples::Users::DeleteUser Class Reference

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

#include <DeleteUser.h>

Public Member Functions
	DeleteUser (const std::string description)
	~DeleteUser ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Delete a selected user 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	SelectUserIndex (VxSdk::VxCollection< VxSdk::IVxUser ** > &users)
	Select a user from the given collection by user input. More...

Static Protected Member Functions
static VxSdk::VxCollection< VxSdk::IVxUser ** >	GetUsers (VxSdk::IVxSystem *vxSystem)
	Get a collection of users from the given VideoExpert system. More...
static void	PrintUsers (VxSdk::VxCollection< VxSdk::IVxUser ** > userCollection)
	Prints the given collection of users to the screen. More...

Detailed Description

This plugin sample delete a selected user from the current system.

Definition at line 12 of file DeleteUser.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Users::DeleteUser::DeleteUser ( const std::string  description )

inline

Definition at line 14 of file DeleteUser.h.

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

CppSamples::Users::DeleteUser::~DeleteUser ( )

inline

Definition at line 15 of file DeleteUser.h.

{ }

Member Function Documentation

VxCollection< IVxUser ** > CppSamples::Users::DeleteUser::GetUsers ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of users from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of users.

Definition at line 45 of file DeleteUser.cpp.

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

void CppSamples::Users::DeleteUser::PrintUsers ( VxSdk::VxCollection< VxSdk::IVxUser ** >  userCollection )

staticprotected

Prints the given collection of users to the screen.

Parameters

userCollection

Collection of users.

Definition at line 59 of file DeleteUser.cpp.

                                                                                 {

    cout << userCollection.collectionSize << " users found." << "\n";
    if (userCollection.collectionSize == 0)
        return;

    cout << "---------------------------------------------------------------------------------------------";
    for (int i = 0; i < userCollection.collectionSize; i++) {
        IVxUser* user = userCollection.collection[i];

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

Plugin * CppSamples::Users::DeleteUser::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Delete a selected user from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file DeleteUser.cpp.

                                                           {
    Utility::ClearScreen();

    VxCollection<IVxUser**> users = GetUsers(dataModel->VxSystem);
    PrintUsers(users);

    if (users.collectionSize > 0) {
        int index = SelectUserIndex(users);
        if (index >= 0) {
            IVxUser* user = users.collection[index];
            VxResult::Value result = user->DeleteUser();
            if (result == VxResult::kOK)
                cout << "\n" << "User deleted succesfully.\n";
            else
                cout << "\n" << "Failed to delete user!!\n";
        }
    }

    // Remove the memory allocated to the collection.
    delete[] users.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::Users::DeleteUser::SelectUserIndex ( VxSdk::VxCollection< VxSdk::IVxUser ** > &  users )

protected

Select a user from the given collection by user input.

Parameters

users

Collection of user.

Returns

Index of the selected user in the given collection.

Definition at line 82 of file DeleteUser.cpp.

                                                                             {
    while (true) {
        cout << "\n" << "Enter user number [1-" << users.collectionSize << "] : ";
        int index = Utility::ReadInt();
        if (index == 0)
            break;
        if (index > 0 && index <= users.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/Users/DeleteUser.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Users/DeleteUser.cpp