CppSamples::Bookmarks::AddBookmark Class Reference

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

#include <AddBookmark.h>

Public Member Functions
	AddBookmark (const std::string description)
	~AddBookmark ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Adds a bookmark 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
void	AddNew (VxSdk::IVxSystem *vxSystem)
	Add a new bookmark to server. More...
VxSdk::VxCollection< VxSdk::IVxDataSource ** >	GetDataSources (VxSdk::IVxSystem *vxSystem)
	Get a collection of data source from the given VideoExpert system. More...
int	SelectDataSourceIndex (VxSdk::VxCollection< VxSdk::IVxDataSource ** > &dataSources)
	Select a data source from the given collection by user input. More...

Detailed Description

This plugin sample adds a bookmark to the current system.

Definition at line 12 of file AddBookmark.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

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

inline

Definition at line 16 of file AddBookmark.h.

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

CppSamples::Bookmarks::AddBookmark::~AddBookmark ( )

inline

Definition at line 17 of file AddBookmark.h.

{}

Member Function Documentation

void CppSamples::Bookmarks::AddBookmark::AddNew ( VxSdk::IVxSystem *  vxSystem )

private

Add a new bookmark to server.

Parameters

vxSystem

Pointer to the VideoExpert system.

Definition at line 25 of file AddBookmark.cpp.

                                                               {
    // Data Source ID
    VxCollection<IVxDataSource**> dataSources = GetDataSources(vxSystem);
    int dataSourceIndex = SelectDataSourceIndex(dataSources);
    if (dataSourceIndex < 0)
        return;

    string dataSourceId = dataSources.collection[dataSourceIndex]->id;

    // Description
    cout << "\n\n" << "Enter description for bookmark: ";
    string description = Utility::ReadString();

    // Time
    cout << "\n" << "Enter time (yyyy-mm-dd hh:mm:ss): ";
    struct tm strtTime = Utility::GetDateAndTimeFromUser();
    string time = Utility::ConvertLocalTimetoUTC(strtTime);

    VxNewBookmark bookmark;
    Utilities::StrCopySafe(bookmark.dataSourceId, dataSourceId.c_str());
    Utilities::StrCopySafe(bookmark.description, description.c_str());
    Utilities::StrCopySafe(bookmark.time, time.c_str());

    VxResult::Value result = vxSystem->AddBookmark(bookmark);
    if (result == VxResult::kOK)
        cout << "\n" << "Bookmark added succesfully.\n";
    else
        cout << "\n" << "Failed to add bookmark.\n";

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

VxCollection< IVxDataSource ** > CppSamples::Bookmarks::AddBookmark::GetDataSources ( VxSdk::IVxSystem *  vxSystem )

private

Get a collection of data source from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of data source.

Definition at line 63 of file AddBookmark.cpp.

                                                                                                {
    cout << "\nFetching datasources from system, Please wait...\n";
    // Read the size of collection from system.
    VxCollection<IVxDataSource**> dataSources;
    VxResult::Value result = vxSystem->GetDataSources(dataSources);
    if (result == VxResult::kInsufficientSize) {
        // Allocate memory for the requried collection.
        dataSources.collection = new IVxDataSource*[dataSources.collectionSize];
        // Read the collection from system.
        vxSystem->GetDataSources(dataSources);
    }
    // Print the number of data source items read from the system.
    cout << dataSources.collectionSize << " datasources found.\n";
    return dataSources;
}

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

overridevirtual

Adds a bookmark to the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 14 of file AddBookmark.cpp.

                                                                {
    AddNew(dataModel->VxSystem);

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

int CppSamples::Bookmarks::AddBookmark::SelectDataSourceIndex ( VxSdk::VxCollection< VxSdk::IVxDataSource ** > &  dataSources )

private

Select a data source from the given collection by user input.

Parameters

dataSources

Collection of data source.

Returns

Index of the selected data source in the given collection.

Definition at line 84 of file AddBookmark.cpp.

                                                                                                    {
    while (true) {
        // Select a Data source
        cout << "\n" << "Enter data source number [1-" << dataSources.collectionSize << "] : ";
        int dataSourceNumber = Utility::ReadInt();
        if (dataSourceNumber == 0)
            break;
        // Verify input
        if (dataSourceNumber > 0 && dataSourceNumber <= dataSources.collectionSize)
            return dataSourceNumber - 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/AddBookmark.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Bookmarks/AddBookmark.cpp