CPPCli::Configuration::Time Class Reference

The Time class represents a time configuration. More...

#include <Configuration.h>

Public Member Functions
	Time (VxSdk::IVxConfiguration::Time *vxConfigTime)
	Constructor. More...
virtual	~Time ()
	Destructor. More...
	!Time ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Attributes
VxSdk::IVxConfiguration::Time *	_configTime

Properties
bool	IsTimeServerEnabled [get]
	Gets a value indicating whether or not the external time server is enabled. More...
System::DateTime	CurrentTime [get]
	Gets the current internal system time. More...
System::String^	TimeServerAddress [get]
	Gets the host address of the external time server. More...

Detailed Description

The Time class represents a time configuration.

Definition at line 35 of file Configuration.h.

Constructor & Destructor Documentation

CPPCli::Configuration::Time::Time

(

VxSdk::IVxConfiguration::Time *

vxConfigTime

)

Constructor.

Parameters

vxConfigTime

The vx time configuration.

Definition at line 8 of file Configuration.cpp.

                                                                     {
    _configTime = vxConfigTime;
}

virtual CPPCli::Configuration::Time::~Time ( )

inlinevirtual

Destructor.

Definition at line 47 of file Configuration.h.

                            {
                this->!Time();
            }

CPPCli::Configuration::Time::!Time

(

)

Finaliser.

Definition at line 12 of file Configuration.cpp.

                               {
    _configTime->Delete();
    _configTime = nullptr;
}

Member Function Documentation

CPPCli::Results::Value CPPCli::Configuration::Time::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 17 of file Configuration.cpp.

                                                    {
    return (CPPCli::Results::Value)_configTime->Refresh();
}

Member Data Documentation

VxSdk::IVxConfiguration::Time* CPPCli::Configuration::Time::_configTime

package

Definition at line 94 of file Configuration.h.

Property Documentation

System:: DateTime CPPCli::Configuration::Time::CurrentTime

get

Gets the current internal system time.

The current internal system time.

Definition at line 75 of file Configuration.h.

bool CPPCli::Configuration::Time::IsTimeServerEnabled

get

Gets a value indicating whether or not the external time server is enabled.

true if the external time server is enabled, false if disabled.

Definition at line 66 of file Configuration.h.

System:: String^ CPPCli::Configuration::Time::TimeServerAddress

get

Gets the host address of the external time server.

The external time server host address.

Definition at line 88 of file Configuration.h.

---

The documentation for this class was generated from the following files:

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/Configuration.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/Configuration.cpp