CppSamples::Bookmarks::ViewAllBookmarks Class Reference

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

#include <ViewAllBookmarks.h>

Public Member Functions
	ViewAllBookmarks (const std::string description)
	~ViewAllBookmarks ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Print all bookmarks 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::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 print all bookmarks available in the current system.

Definition at line 12 of file ViewAllBookmarks.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 14 of file ViewAllBookmarks.h.

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

CppSamples::Bookmarks::ViewAllBookmarks::~ViewAllBookmarks ( )

inline

Definition at line 15 of file ViewAllBookmarks.h.

{ }

Member Function Documentation

VxCollection< IVxBookmark ** > CppSamples::Bookmarks::ViewAllBookmarks::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 33 of file ViewAllBookmarks.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::ViewAllBookmarks::PrintBookmarks ( VxSdk::VxCollection< VxSdk::IVxBookmark ** >  bookmarkCollection )

staticprotected

Prints the given collection of bookmarks to the screen.

Parameters

bookmarkCollection

Collection of bookmarks.

Definition at line 47 of file ViewAllBookmarks.cpp.

                                                                                                       {

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

    cout << "------------------------------------------------------------------------------------------\n";
    cout << "No      Data Source Name                Time                            Description \n";
    cout << "------------------------------------------------------------------------------------------";
    for (int i = 0; i < bookmarkCollection.collectionSize; i++) {
        IVxBookmark* bookmark = bookmarkCollection.collection[i];

        string dataSourceName = "";
        IVxDataSource* dataSource = nullptr;
        bookmark->GetDataSource(dataSource);
        if (dataSource != nullptr) {

            dataSourceName = string(dataSource->name);
            dataSourceName += string(30 - dataSourceName.length(), ' ');
        }

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

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

overridevirtual

Print all bookmarks available in the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file ViewAllBookmarks.cpp.

                                                                     {
    Utility::ClearScreen();

    VxCollection<IVxBookmark**> bookmarks = GetBookmarks(dataModel->VxSystem);
    PrintBookmarks(bookmarks);

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

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