VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
VxSdk::VxNewBookmark Struct Reference

Represents a new bookmark to be created. More...

#include <VxNewBookmark.h>

Public Member Functions

 VxNewBookmark ()
 Initializes a new instance of the VxNewBookmark struct. More...
 
 VxNewBookmark (const VxNewBookmark &ref)
 Initializes a new instance of the VxNewBookmark struct. More...
 
 ~VxNewBookmark ()
 Finalizes an instance of the VxNewBookmark class. More...
 
void Clear ()
 Clears this instance. More...
 

Public Attributes

char dataSourceId [64]
 The unique identifier of the data source to associate with the bookmark. More...
 
char description [64]
 The friendly description of the bookmark. More...
 
char name [64]
 The friendly name of the bookmark. More...
 
char time [64]
 The time at which the point of interest occurred. More...
 

Detailed Description

Represents a new bookmark to be created.

Definition at line 12 of file VxNewBookmark.h.

Constructor & Destructor Documentation

VxSdk::VxNewBookmark::VxNewBookmark ( )
inline

Initializes a new instance of the VxNewBookmark struct.

Definition at line 17 of file VxNewBookmark.h.

17  {
18  Clear();
19  }
void Clear()
Clears this instance.
Definition: VxNewBookmark.h:42
VxSdk::VxNewBookmark::VxNewBookmark ( const VxNewBookmark ref)
inline

Initializes a new instance of the VxNewBookmark struct.

Parameters
refThe reference.

Definition at line 25 of file VxNewBookmark.h.

25  {
26  Utilities::StrCopySafe(this->dataSourceId, ref.dataSourceId);
27  Utilities::StrCopySafe(this->description, ref.description);
28  Utilities::StrCopySafe(this->name, ref.name);
29  Utilities::StrCopySafe(this->time, ref.time);
30  }
char time[64]
The time at which the point of interest occurred.
Definition: VxNewBookmark.h:65
static void StrCopySafe(char(&dst)[dstSize], const char *src)
Performs a safe string copy.
Definition: VxUtilities.h:15
char description[64]
The friendly description of the bookmark.
Definition: VxNewBookmark.h:57
char name[64]
The friendly name of the bookmark.
Definition: VxNewBookmark.h:61
char dataSourceId[64]
The unique identifier of the data source to associate with the bookmark.
Definition: VxNewBookmark.h:53
VxSdk::VxNewBookmark::~VxNewBookmark ( )
inline

Finalizes an instance of the VxNewBookmark class.

Definition at line 35 of file VxNewBookmark.h.

35  {
36  Clear();
37  }
void Clear()
Clears this instance.
Definition: VxNewBookmark.h:42

Member Function Documentation

void VxSdk::VxNewBookmark::Clear ( )
inline

Clears this instance.

Definition at line 42 of file VxNewBookmark.h.

42  {
44  VxZeroArray(this->description);
45  VxZeroArray(this->name);
46  VxZeroArray(this->time);
47  }
#define VxZeroArray(src)
Definition: VxMacros.h:25
char time[64]
The time at which the point of interest occurred.
Definition: VxNewBookmark.h:65
char description[64]
The friendly description of the bookmark.
Definition: VxNewBookmark.h:57
char name[64]
The friendly name of the bookmark.
Definition: VxNewBookmark.h:61
char dataSourceId[64]
The unique identifier of the data source to associate with the bookmark.
Definition: VxNewBookmark.h:53

Member Data Documentation

char VxSdk::VxNewBookmark::dataSourceId[64]

The unique identifier of the data source to associate with the bookmark.

Definition at line 53 of file VxNewBookmark.h.

char VxSdk::VxNewBookmark::description[64]

The friendly description of the bookmark.

Definition at line 57 of file VxNewBookmark.h.

char VxSdk::VxNewBookmark::name[64]

The friendly name of the bookmark.

Definition at line 61 of file VxNewBookmark.h.

char VxSdk::VxNewBookmark::time[64]

The time at which the point of interest occurred.

Definition at line 65 of file VxNewBookmark.h.


The documentation for this struct was generated from the following file: