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

Represents a new data object to be created. More...

#include <VxNewDataObject.h>

Public Member Functions

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

Public Attributes

bool isPrivate
 Indicates whether this resource is owned by a user. If true, the data object will be owned by the user submitting the request. More...
 
char clientType [64]
 The client type identifier. Recommend using the Java package naming convention. More...
 
char * data
 The data to add to the data object. More...
 

Detailed Description

Represents a new data object to be created.

Definition at line 12 of file VxNewDataObject.h.

Constructor & Destructor Documentation

VxSdk::VxNewDataObject::VxNewDataObject ( )
inline

Initializes a new instance of the VxNewDataObject struct.

Definition at line 17 of file VxNewDataObject.h.

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

Initializes a new instance of the VxNewDataObject struct.

Parameters
refThe reference.

Definition at line 25 of file VxNewDataObject.h.

25  {
26  this->isPrivate = ref.isPrivate;
27  Utilities::StrCopySafe(this->clientType, ref.clientType);
28  this->data = ref.data;
29  }
static void StrCopySafe(char(&dst)[dstSize], const char *src)
Performs a safe string copy.
Definition: VxUtilities.h:15
char * data
The data to add to the data object.
char clientType[64]
The client type identifier. Recommend using the Java package naming convention.
bool isPrivate
Indicates whether this resource is owned by a user. If true, the data object will be owned by the use...
VxSdk::VxNewDataObject::~VxNewDataObject ( )
inline

Finalizes an instance of the VxNewDataObject class.

Definition at line 34 of file VxNewDataObject.h.

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

Member Function Documentation

void VxSdk::VxNewDataObject::Clear ( )
inline

Clears this instance.

Definition at line 41 of file VxNewDataObject.h.

41  {
42  this->isPrivate = false;
43  VxZeroArray(this->clientType);
44  this->data = nullptr;
45  }
#define VxZeroArray(src)
Definition: VxMacros.h:25
char * data
The data to add to the data object.
char clientType[64]
The client type identifier. Recommend using the Java package naming convention.
bool isPrivate
Indicates whether this resource is owned by a user. If true, the data object will be owned by the use...

Member Data Documentation

char VxSdk::VxNewDataObject::clientType[64]

The client type identifier. Recommend using the Java package naming convention.

Definition at line 55 of file VxNewDataObject.h.

char* VxSdk::VxNewDataObject::data

The data to add to the data object.

Definition at line 59 of file VxNewDataObject.h.

bool VxSdk::VxNewDataObject::isPrivate

Indicates whether this resource is owned by a user. If true, the data object will be owned by the user submitting the request.

Definition at line 51 of file VxNewDataObject.h.


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