CPPCli::Bookmark Class Reference

The Bookmark class represents a point in time of interest with reference to a particular data source. More...

#include <Bookmark.h>

Public Member Functions
	Bookmark (VxSdk::IVxBookmark *vxBookmark)
	Constructor. More...
virtual	~Bookmark ()
	Destructor. More...
	!Bookmark ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
CPPCli::DataSource^	_GetDataSource ()

Package Attributes
VxSdk::IVxBookmark *	_bookmark

Properties
System::String^	Description [get, set]
	Gets or sets the friendly description of the bookmark. More...
System::String^	Id [get]
	Gets the unique bookmark identifier. More...
System::String^	Name [get, set]
	Gets or sets the friendly name. More...
System::DateTime	Time [get]
	Gets the date and time at which the point of interest occurred. More...
CPPCli::DataSource^	DataSource [get]
	Gets the data source associated with this bookmark. More...

Detailed Description

The Bookmark class represents a point in time of interest with reference to a particular data source.

Definition at line 14 of file Bookmark.h.

Constructor & Destructor Documentation

CPPCli::Bookmark::Bookmark

(

VxSdk::IVxBookmark *

vxBookmark

)

Constructor.

Parameters

vxBookmark

The vx bookmark.

Definition at line 8 of file Bookmark.cpp.

                                                     {
    _bookmark = vxBookmark;
}

virtual CPPCli::Bookmark::~Bookmark ( )

inlinevirtual

Destructor.

Definition at line 26 of file Bookmark.h.

                            {
            this->!Bookmark();
        }

CPPCli::Bookmark::!Bookmark

(

)

Finaliser.

Definition at line 12 of file Bookmark.cpp.

                          {
    _bookmark->Delete();
    _bookmark = nullptr;
}

Member Function Documentation

CPPCli::DataSource CPPCli::Bookmark::_GetDataSource ( )

package

Definition at line 21 of file Bookmark.cpp.

                                                 {
    // Get the data source
    VxSdk::IVxDataSource* dataSource = nullptr;
    VxSdk::VxResult::Value result = _bookmark->GetDataSource(dataSource);

    // Return the data source if GetDataSource was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::DataSource(dataSource);

    return nullptr;
}

CPPCli::Results::Value CPPCli::Bookmark::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 17 of file Bookmark.cpp.

                                           {
    return (CPPCli::Results::Value)_bookmark->Refresh();
}

Member Data Documentation

VxSdk::IVxBookmark* CPPCli::Bookmark::_bookmark

package

Definition at line 97 of file Bookmark.h.

Property Documentation

CPPCli:: DataSource^ CPPCli::Bookmark::DataSource

get

Gets the data source associated with this bookmark.

The associated data source.

Definition at line 91 of file Bookmark.h.

System:: String^ CPPCli::Bookmark::Description

getset

Gets or sets the friendly description of the bookmark.

The friendly description.

Definition at line 45 of file Bookmark.h.

System:: String^ CPPCli::Bookmark::Id

get

Gets the unique bookmark identifier.

The unique identifier.

Definition at line 59 of file Bookmark.h.

System:: String^ CPPCli::Bookmark::Name

getset

Gets or sets the friendly name.

The friendly name.

Definition at line 68 of file Bookmark.h.

System:: DateTime CPPCli::Bookmark::Time

get

Gets the date and time at which the point of interest occurred.

A default DateTime if it fails, else the DateTime at which the point of interest occurred.

Definition at line 82 of file Bookmark.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/Bookmark.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/Bookmark.cpp