VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxConfiguration::Time Struct Referenceabstract

Represents the time configuration. More...

#include <IVxConfiguration.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetTime (char currentTime[64])=0
 Gets the current internal system time. More...
 
virtual VxResult::Value Refresh ()=0
 Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
 

Public Attributes

bool isTimeServerEnabled
 Indicates whether or not the external time server is enabled. More...
 
char timeServerAddress [64]
 The host address of the external time server. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents the time configuration.

Definition at line 15 of file IVxConfiguration.h.

Member Function Documentation

void VxSdk::IVxConfiguration::Time::Clear ( )
inlineprotected

Clears this instance.

Definition at line 48 of file IVxConfiguration.h.

48  {
49  isTimeServerEnabled = false;
50  VxZeroArray(this->timeServerAddress);
51  }
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxConfiguration::Time::timeServerAddress
char timeServerAddress[64]
The host address of the external time server.
Definition: IVxConfiguration.h:42
VxSdk::IVxConfiguration::Time::isTimeServerEnabled
bool isTimeServerEnabled
Indicates whether or not the external time server is enabled.
Definition: IVxConfiguration.h:38
virtual VxResult::Value VxSdk::IVxConfiguration::Time::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxConfiguration::Time::GetTime ( char  currentTime[64])
pure virtual

Gets the current internal system time.

Parameters
currentTimeThe current internal time from the system.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxConfiguration::Time::Refresh ( )
pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns
The Result of refreshing the member values for this object.

Member Data Documentation

bool VxSdk::IVxConfiguration::Time::isTimeServerEnabled

Indicates whether or not the external time server is enabled.

Definition at line 38 of file IVxConfiguration.h.

char VxSdk::IVxConfiguration::Time::timeServerAddress[64]

The host address of the external time server.

Definition at line 42 of file IVxConfiguration.h.

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