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

Represents a new quick report. More...

#include <VxNewQuickReport.h>

Public Member Functions

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

Public Attributes

char endTime [64]
 The time (RFC 3339 format) at which to end the contents of the report. Defaults to the earliest content available. More...
 
char startTime [64]
 The time (RFC 3339 format) at which to start the contents of the report. Defaults to the oldest content available. More...
 
int contentsSize
 The size of contents. More...
 
VxReportContent::Valuecontents
 The report content types to include in the report. Reports will include all types if not set. More...
 

Detailed Description

Represents a new quick report.

Definition at line 12 of file VxNewQuickReport.h.

Constructor & Destructor Documentation

VxSdk::VxNewQuickReport::VxNewQuickReport ( )
inline

Initializes a new instance of the VxNewQuickReport struct.

Definition at line 17 of file VxNewQuickReport.h.

17  {
18  Clear();
19  }
void Clear()
Clears this instance.
VxSdk::VxNewQuickReport::VxNewQuickReport ( const VxNewQuickReport ref)
inline

Initializes a new instance of the VxNewQuickReport struct.

Parameters
refThe reference.

Definition at line 25 of file VxNewQuickReport.h.

25  {
26  Utilities::StrCopySafe(this->endTime, ref.endTime);
27  Utilities::StrCopySafe(this->startTime, ref.startTime);
28  this->contentsSize = ref.contentsSize;
29  this->contents = ref.contents;
30  }
char endTime[64]
The time (RFC 3339 format) at which to end the contents of the report. Defaults to the earliest conte...
static void StrCopySafe(char(&dst)[dstSize], const char *src)
Performs a safe string copy.
Definition: VxUtilities.h:15
int contentsSize
The size of contents.
char startTime[64]
The time (RFC 3339 format) at which to start the contents of the report. Defaults to the oldest conte...
VxReportContent::Value * contents
The report content types to include in the report. Reports will include all types if not set...
VxSdk::VxNewQuickReport::~VxNewQuickReport ( )
inline

Finalizes an instance of the VxNewQuickReport class.

Definition at line 35 of file VxNewQuickReport.h.

35  {
36  Clear();
37  }
void Clear()
Clears this instance.

Member Function Documentation

void VxSdk::VxNewQuickReport::Clear ( )
inline

Clears this instance.

Definition at line 42 of file VxNewQuickReport.h.

42  {
43  VxZeroArray(this->endTime);
44  VxZeroArray(this->startTime);
45  this->contentsSize = 0;
46  this->contents = nullptr;
47  }
#define VxZeroArray(src)
Definition: VxMacros.h:25
char endTime[64]
The time (RFC 3339 format) at which to end the contents of the report. Defaults to the earliest conte...
int contentsSize
The size of contents.
char startTime[64]
The time (RFC 3339 format) at which to start the contents of the report. Defaults to the oldest conte...
VxReportContent::Value * contents
The report content types to include in the report. Reports will include all types if not set...

Member Data Documentation

VxReportContent::Value* VxSdk::VxNewQuickReport::contents

The report content types to include in the report. Reports will include all types if not set.

Definition at line 68 of file VxNewQuickReport.h.

int VxSdk::VxNewQuickReport::contentsSize

The size of contents.

Definition at line 63 of file VxNewQuickReport.h.

char VxSdk::VxNewQuickReport::endTime[64]

The time (RFC 3339 format) at which to end the contents of the report. Defaults to the earliest content available.

Definition at line 54 of file VxNewQuickReport.h.

char VxSdk::VxNewQuickReport::startTime[64]

The time (RFC 3339 format) at which to start the contents of the report. Defaults to the oldest content available.

Definition at line 59 of file VxNewQuickReport.h.


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