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

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

#include <VxNewMarker.h>

Public Member Functions

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

Public Attributes

char associatedDataSourceId [64]
 The unique identifier of the data source to associate with the marker. More...
 
char name [64]
 The friendly name of the marker. More...
 
float direction
 The angular coordinate indicating the direction that the marker is facing on a polar grid. (e.g.: 0[right], 90[up], 180[left], 270[down]). More...
 
float x
 The X cartesian coordinate. More...
 
float y
 The Y cartesian coordinate. More...
 

Detailed Description

Represents a new marker to be created.

Definition at line 12 of file VxNewMarker.h.

Constructor & Destructor Documentation

VxSdk::VxNewMarker::VxNewMarker ( )
inline

Initializes a new instance of the VxNewMarker struct.

Definition at line 17 of file VxNewMarker.h.

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

Initializes a new instance of the VxNewMarker struct.

Parameters
refThe reference.

Definition at line 25 of file VxNewMarker.h.

25  {
26  Utilities::StrCopySafe(this->associatedDataSourceId, ref.associatedDataSourceId);
27  Utilities::StrCopySafe(this->name, ref.name);
28  this->direction = ref.direction;
29  this->x = ref.x;
30  this->y = ref.y;
31  }
float y
The Y cartesian coordinate.
Definition: VxNewMarker.h:72
char associatedDataSourceId[64]
The unique identifier of the data source to associate with the marker.
Definition: VxNewMarker.h:55
char name[64]
The friendly name of the marker.
Definition: VxNewMarker.h:59
static void StrCopySafe(char(&dst)[dstSize], const char *src)
Performs a safe string copy.
Definition: VxUtilities.h:15
float x
The X cartesian coordinate.
Definition: VxNewMarker.h:68
float direction
The angular coordinate indicating the direction that the marker is facing on a polar grid...
Definition: VxNewMarker.h:64
VxSdk::VxNewMarker::~VxNewMarker ( )
inline

Finalizes an instance of the VxNewMarker class.

Definition at line 36 of file VxNewMarker.h.

36  {
37  Clear();
38  }
void Clear()
Clears this instance.
Definition: VxNewMarker.h:43

Member Function Documentation

void VxSdk::VxNewMarker::Clear ( )
inline

Clears this instance.

Definition at line 43 of file VxNewMarker.h.

43  {
45  VxZeroArray(this->name);
46  this->direction = 0;
47  this->x = 0;
48  this->y = 0;
49  }
#define VxZeroArray(src)
Definition: VxMacros.h:25
float y
The Y cartesian coordinate.
Definition: VxNewMarker.h:72
char associatedDataSourceId[64]
The unique identifier of the data source to associate with the marker.
Definition: VxNewMarker.h:55
char name[64]
The friendly name of the marker.
Definition: VxNewMarker.h:59
float x
The X cartesian coordinate.
Definition: VxNewMarker.h:68
float direction
The angular coordinate indicating the direction that the marker is facing on a polar grid...
Definition: VxNewMarker.h:64

Member Data Documentation

char VxSdk::VxNewMarker::associatedDataSourceId[64]

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

Definition at line 55 of file VxNewMarker.h.

float VxSdk::VxNewMarker::direction

The angular coordinate indicating the direction that the marker is facing on a polar grid. (e.g.: 0[right], 90[up], 180[left], 270[down]).

Definition at line 64 of file VxNewMarker.h.

char VxSdk::VxNewMarker::name[64]

The friendly name of the marker.

Definition at line 59 of file VxNewMarker.h.

float VxSdk::VxNewMarker::x

The X cartesian coordinate.

Definition at line 68 of file VxNewMarker.h.

float VxSdk::VxNewMarker::y

The Y cartesian coordinate.

Definition at line 72 of file VxNewMarker.h.


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