CppSamples::Bookmarks::DeleteBookmark Class Reference

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

#include <DeleteBookmark.h>

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

Static Protected Member Functions
static VxSdk::VxCollection< VxSdk::IVxBookmark ** >	GetBookmarks (VxSdk::IVxSystem *vxSystem)
	Get a collection of bookmarks from the given VideoExpert system. More...
static void	PrintBookmarks (VxSdk::VxCollection< VxSdk::IVxBookmark ** > bookmarkCollection)
	Prints the given collection of bookmarks to the screen. More...

Detailed Description

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

Definition at line 12 of file DeleteBookmark.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Bookmarks::DeleteBookmark::DeleteBookmark ( const std::string  description )

inline

Definition at line 14 of file DeleteBookmark.h.

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

CppSamples::Bookmarks::DeleteBookmark::~DeleteBookmark ( )

inline

Definition at line 15 of file DeleteBookmark.h.

{ }

Member Function Documentation

VxCollection< IVxBookmark ** > CppSamples::Bookmarks::DeleteBookmark::GetBookmarks ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of bookmarks from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of bookmarks.

Definition at line 48 of file DeleteBookmark.cpp.

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

void CppSamples::Bookmarks::DeleteBookmark::PrintBookmarks ( VxSdk::VxCollection< VxSdk::IVxBookmark ** >  bookmarkCollection )

staticprotected

Prints the given collection of bookmarks to the screen.

Parameters

bookmarkCollection

Collection of bookmarks.

Definition at line 62 of file DeleteBookmark.cpp.

                                                                                                     {

    cout << bookmarkCollection.collectionSize << " bookmarks found." << "\n";
    if (bookmarkCollection.collectionSize == 0)
        return;

    cout << "------------------------------------------------------------------------------------------";
    for (int i = 0; i < bookmarkCollection.collectionSize; i++) {
        IVxBookmark* bookmark = bookmarkCollection.collection[i];

        cout << "\n" << (i + 1);
        cout << "\t" << bookmark->id;
        cout << "\t" << bookmark->time;
        cout << "\t" << bookmark->description;
    }
    cout << "\n------------------------------------------------------------------------------------------\n";
}

Plugin * CppSamples::Bookmarks::DeleteBookmark::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Delete a selected bookmark from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file DeleteBookmark.cpp.

                                                                   {
    system("cls");

    // Read book marks from current system
    VxCollection<IVxBookmark**> bookmarks = GetBookmarks(dataModel->VxSystem);
    PrintBookmarks(bookmarks);

    if (bookmarks.collectionSize > 0) {
        // Select the book mark to delete
        int index = SelectBookmarkIndex(bookmarks);
        if (index >= 0) {
            IVxBookmark* bookmark = bookmarks.collection[index];
            VxResult::Value result = bookmark->DeleteBookmark();
            if (result == VxResult::kOK)
                cout << "\n" << "Bookmark deleted succesfully.\n";
            else
                cout << "\n" << "Failed to delete bookmark!!\n";
        }
    }

    // Remove the memory allocated to the collection.
    delete[] bookmarks.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::Bookmarks::DeleteBookmark::SelectBookmarkIndex ( VxSdk::VxCollection< VxSdk::IVxBookmark ** > &  bookmarks )

protected

Select a bookmark from the given collection by user input.

Parameters

bookmarks

Collection of bookmark.

Returns

Index of the selected bookmark in the given collection.

Definition at line 85 of file DeleteBookmark.cpp.

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