VxSdk::VxNewDevice Struct Reference

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

#include <VxNewDevice.h>

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

Public Attributes
bool	shouldAutoCommission
	True to have this device automatically commissioned when created. More...
char	dataStorageId [64]
	The data storage id to assign this device to using the driver specified by driverType. More...
char	driverType [64]
	The type identifier of the driver to use for the device when assigning it to a data storage. More...
char	id [64]
	The id of this device More...
char	ip [64]
	The primary IP address. The IP address must be unique for this type of device. More...
char	name [64]
	The friendly name of the device. More...
char	password [64]
	The account password used to communicate with the device, if any. More...
char	username [64]
	The account username used to communicate with the device, if any. More...
VxDeviceType::Value	type
	The particular type of the device. More...

Detailed Description

Represents a new device to be created.

Definition at line 12 of file VxNewDevice.h.

Constructor & Destructor Documentation

VxSdk::VxNewDevice::VxNewDevice ( )

inline

Initializes a new instance of the VxNewDevice struct.

Definition at line 17 of file VxNewDevice.h.

                      {
            Clear();
        }

VxSdk::VxNewDevice::VxNewDevice ( const VxNewDevice &  ref )

inline

Initializes a new instance of the VxNewDevice struct.

Parameters

ref	The reference.

Definition at line 25 of file VxNewDevice.h.

                                            {
            this->shouldAutoCommission = ref.shouldAutoCommission;
            Utilities::StrCopySafe(this->dataStorageId, ref.dataStorageId);
            Utilities::StrCopySafe(this->driverType, ref.driverType);
            Utilities::StrCopySafe(this->id, ref.id);
            Utilities::StrCopySafe(this->ip, ref.ip);
            Utilities::StrCopySafe(this->name, ref.name);
            Utilities::StrCopySafe(this->password, ref.password);
            Utilities::StrCopySafe(this->username, ref.username);
            this->type = ref.type;
        }

VxSdk::VxNewDevice::~VxNewDevice ( )

inline

Finalizes an instance of the VxNewDevice class.

Definition at line 40 of file VxNewDevice.h.

                       {
            Clear();
        }

Member Function Documentation

void VxSdk::VxNewDevice::Clear ( )

inline

Clears this instance.

Definition at line 47 of file VxNewDevice.h.

                     {
            shouldAutoCommission = false;
            VxZeroArray(this->dataStorageId);
            VxZeroArray(this->driverType);
            VxZeroArray(this->id);
            VxZeroArray(this->ip);
            VxZeroArray(this->name);
            VxZeroArray(this->password);
            VxZeroArray(this->username);
            type = VxDeviceType::kUnknown;
        }

Member Data Documentation

char VxSdk::VxNewDevice::dataStorageId[64]

The data storage id to assign this device to using the driver specified by driverType.

Definition at line 67 of file VxNewDevice.h.

char VxSdk::VxNewDevice::driverType[64]

The type identifier of the driver to use for the device when assigning it to a data storage.

Definition at line 71 of file VxNewDevice.h.

char VxSdk::VxNewDevice::id[64]

The id of this device

Definition at line 75 of file VxNewDevice.h.

char VxSdk::VxNewDevice::ip[64]

The primary IP address. The IP address must be unique for this type of device.

Definition at line 79 of file VxNewDevice.h.

char VxSdk::VxNewDevice::name[64]

The friendly name of the device.

Definition at line 83 of file VxNewDevice.h.

char VxSdk::VxNewDevice::password[64]

The account password used to communicate with the device, if any.

Definition at line 87 of file VxNewDevice.h.

bool VxSdk::VxNewDevice::shouldAutoCommission

True to have this device automatically commissioned when created.

Definition at line 63 of file VxNewDevice.h.

VxDeviceType::Value VxSdk::VxNewDevice::type

The particular type of the device.

Definition at line 95 of file VxNewDevice.h.

char VxSdk::VxNewDevice::username[64]

The account username used to communicate with the device, if any.

Definition at line 91 of file VxNewDevice.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/VxNewDevice.h