Device info

Collaboration diagram for Device info:

Detailed Description

Modules
	Factories

Classes
struct	IDeviceInfo
	Contains standard information about an openDAQ device and device type. The Device Info object is a Property Object, allowing for custom String, Int, Bool, or Float-type properties to be added. More...
struct	IDeviceInfoConfig
	Configuration component of Device info objects. Contains setter methods that are available until the object is frozen. More...
struct	INetworkInterface
	Provides an interface to manipulate the configuration of a device's (server's) network interface. Offers methods to update the IP configuration and retrieve the currently active one, if the corresponding feature supported by the device. Additionally, includes a helper method to create a prebuilt property object with valid default configuration. More...
class	DeviceInfoConfigPtr
	Configuration component of Device info objects. Contains setter methods that are available until the object is frozen. More...
class	GenericDeviceInfoPtr< InterfaceType >
	Contains standard information about an openDAQ device and device type. The Device Info object is a Property Object, allowing for custom String, Int, Bool, or Float-type properties to be added. More...
class	NetworkInterfacePtr
	Provides an interface to manipulate the configuration of a device's (server's) network interface. Offers methods to update the IP configuration and retrieve the currently active one, if the corresponding feature supported by the device. Additionally, includes a helper method to create a prebuilt property object with valid default configuration. More...

Functions
void	setName (const daq::StringPtr &name) const
	Sets the name of the device. More...
void	setConnectionString (const daq::StringPtr &connectionString) const
	Sets the string representation of a connection address used to connect to the device. More...
void	setDeviceType (const daq::DeviceTypePtr &deviceType) const
	Sets a device type as an object providing type id, name, short description and default device configuration. More...
void	setManufacturer (const daq::StringPtr &manufacturer) const
	Sets the company that manufactured the device. More...
void	setManufacturerUri (const daq::StringPtr &manufacturerUri) const
	Sets the unique identifier of the company that manufactured the device. This identifier should be a fully qualified domain name; however, it may be a GUID or similar construct that ensures global uniqueness. More...
void	setModel (const daq::StringPtr &model) const
	Sets the model of the device. More...
void	setProductCode (const daq::StringPtr &productCode) const
	Sets the unique combination of numbers and letters used to identify the device. More...
void	setDeviceRevision (const daq::StringPtr &deviceRevision) const
	Sets the revision level of the device. More...
void	setHardwareRevision (const daq::StringPtr &hardwareRevision) const
	Sets the revision level of the hardware. More...
void	setSoftwareRevision (const daq::StringPtr &softwareRevision) const
	sets the revision level of the software component More...
void	setDeviceManual (const daq::StringPtr &deviceManual) const
	Sets the address of the user manual. It may be a pathname in the file system or a URL (Web address) More...
void	setDeviceClass (const daq::StringPtr &deviceClass) const
	Sets the purpose of the device. For example "TestMeasurementDevice". More...
void	setSerialNumber (const daq::StringPtr &serialNumber) const
	Sets the serial number of the device. More...
void	setProductInstanceUri (const daq::StringPtr &productInstanceUri) const
	Sets the globally unique resource identifier provided by the manufacturer. The recommended syntax of the ProductInstanceUri is: <ManufacturerUri>/<any string> where <any string> is unique among all instances using the same ManufacturerUri. More...
void	setRevisionCounter (daq::Int revisionCounter) const
	Sets the incremental counter indicating the number of times the configuration data has been modified. More...
void	setAssetId (const daq::StringPtr &id) const
	Sets the asset ID of the device. Represents a user writable alphanumeric character sequence uniquely identifying a component. More...
void	setMacAddress (const daq::StringPtr &macAddress) const
	Sets the Mac address of the device. More...
void	setParentMacAddress (const daq::StringPtr &macAddress) const
	Sets the Mac address of the device's parent. More...
void	setPlatform (const daq::StringPtr &platform) const
	Sets the platform of the device. The platform specifies whether real hardware is used or if the device is simulated. More...
void	setPosition (daq::Int position) const
	Sets the position of the device. The position specifies the position within a given system. For example in which slot or slice the device is in. More...
void	setSystemType (const daq::StringPtr &type) const
	Sets the system type. The system type can, for example, be LayeredSystem, StandaloneSystem, or RackSystem. More...
void	setSystemUuid (const daq::StringPtr &uuid) const
	Sets the system UUID that represents a unique ID of a system. All devices in a system share this UUID. More...
void	setLocation (const daq::StringPtr &location) const
	Sets the location of the device. More...
void	setUserName (const daq::StringPtr &userName) const
	Sets the name of the current user of the device. More...
daq::PropertyObjectPtr	requestCurrentConfiguration () const
	Requests the currently active configuration for the network interface. More...
void	submitConfiguration (const daq::PropertyObjectPtr &config) const
	Submits a new configuration for the network interface. More...
daq::PropertyObjectPtr	createDefaultConfiguration () const
	Creates a property object containing default configuration values for a network interface. More...

Function Documentation

createDefaultConfiguration()

daq::PropertyObjectPtr createDefaultConfiguration ( ) const

inline

Creates a property object containing default configuration values for a network interface.

Returns

The configuration object containing default settings for configuring device's network interface.

The created object can be modified or directly submitted using the submitConfiguration method.

requestCurrentConfiguration()

daq::PropertyObjectPtr requestCurrentConfiguration ( ) const

inline

Requests the currently active configuration for the network interface.

Returns

The property object containing the currently active configuration.

Exceptions

NotImplementedException

if the device doesn't support retrieving the active configuration.

setAssetId()

void setAssetId ( const daq::StringPtr &  id ) const

inline

Sets the asset ID of the device. Represents a user writable alphanumeric character sequence uniquely identifying a component.

Parameters

id	The asset ID of the device.

The ID is provided by the integrator or user of the device. It contains typically an identifier in a branch, use case or user specific naming scheme. This could be for example a reference to an electric scheme.

setConnectionString()

void setConnectionString ( const daq::StringPtr &  connectionString ) const

inline

Sets the string representation of a connection address used to connect to the device.

Parameters

connectionString

The string used to connect to the device.

setDeviceClass()

void setDeviceClass ( const daq::StringPtr &  deviceClass ) const

inline

Sets the purpose of the device. For example "TestMeasurementDevice".

Parameters

deviceClass

The class of the device.

setDeviceManual()

void setDeviceManual ( const daq::StringPtr &  deviceManual ) const

inline

Sets the address of the user manual. It may be a pathname in the file system or a URL (Web address)

Parameters

deviceManual

The manual of the device.

setDeviceRevision()

void setDeviceRevision ( const daq::StringPtr &  deviceRevision ) const

inline

Sets the revision level of the device.

Parameters

deviceRevision

The device revision level.

setDeviceType()

void setDeviceType ( const daq::DeviceTypePtr &  deviceType ) const

inline

Sets a device type as an object providing type id, name, short description and default device configuration.

Parameters

[out]

deviceType

The device type object

setHardwareRevision()

void setHardwareRevision ( const daq::StringPtr &  hardwareRevision ) const

inline

Sets the revision level of the hardware.

Parameters

hardwareRevision

The hardware revision of the device.

setLocation()

void setLocation ( const daq::StringPtr &  location ) const

inline

Sets the location of the device.

Parameters

[out]

location

The location of the device.

setMacAddress()

void setMacAddress ( const daq::StringPtr &  macAddress ) const

inline

Sets the Mac address of the device.

Parameters

macAddress

The Mac address.

setManufacturer()

void setManufacturer ( const daq::StringPtr &  manufacturer ) const

inline

Sets the company that manufactured the device.

Parameters

manufacturer

The manufacturer of the device.

setManufacturerUri()

void setManufacturerUri ( const daq::StringPtr &  manufacturerUri ) const

inline

Sets the unique identifier of the company that manufactured the device. This identifier should be a fully qualified domain name; however, it may be a GUID or similar construct that ensures global uniqueness.

Parameters

manufacturerUri

The manufacturer uri of the device.

setModel()

void setModel ( const daq::StringPtr &  model ) const

inline

Sets the model of the device.

Parameters

model

The model of the device.

setName()

void setName ( const daq::StringPtr &  name ) const

inline

Sets the name of the device.

Parameters

name	The name of the device.

setParentMacAddress()

void setParentMacAddress ( const daq::StringPtr &  macAddress ) const

inline

Sets the Mac address of the device's parent.

Parameters

macAddress

The parent's Mac address.

setPlatform()

void setPlatform ( const daq::StringPtr &  platform ) const

inline

Sets the platform of the device. The platform specifies whether real hardware is used or if the device is simulated.

Parameters

platform

The platform of the device.

setPosition()

void setPosition ( daq::Int  position ) const

inline

Sets the position of the device. The position specifies the position within a given system. For example in which slot or slice the device is in.

Parameters

position

The position of the device.

setProductCode()

void setProductCode ( const daq::StringPtr &  productCode ) const

inline

Sets the unique combination of numbers and letters used to identify the device.

Parameters

productCode

The product code of the device.

setProductInstanceUri()

void setProductInstanceUri ( const daq::StringPtr &  productInstanceUri ) const

inline

Sets the globally unique resource identifier provided by the manufacturer. The recommended syntax of the ProductInstanceUri is: <ManufacturerUri>/<any string> where <any string> is unique among all instances using the same ManufacturerUri.

Parameters

productInstanceUri

The product instance uri of the device.

setRevisionCounter()

void setRevisionCounter ( daq::Int  revisionCounter ) const

inline

Sets the incremental counter indicating the number of times the configuration data has been modified.

Parameters

revisionCounter

The revision counter of the device.

setSerialNumber()

void setSerialNumber ( const daq::StringPtr &  serialNumber ) const

inline

Sets the serial number of the device.

Parameters

serialNumber

The serial number of the device.

setSoftwareRevision()

void setSoftwareRevision ( const daq::StringPtr &  softwareRevision ) const

inline

sets the revision level of the software component

Parameters

softwareRevision

The software revision of the device.

setSystemType()

void setSystemType ( const daq::StringPtr &  type ) const

inline

Sets the system type. The system type can, for example, be LayeredSystem, StandaloneSystem, or RackSystem.

Parameters

type	The system type of the device.

setSystemUuid()

void setSystemUuid ( const daq::StringPtr &  uuid ) const

inline

Sets the system UUID that represents a unique ID of a system. All devices in a system share this UUID.

Parameters

uuid	The unique ID of a system.

setUserName()

void setUserName ( const daq::StringPtr &  userName ) const

inline

Sets the name of the current user of the device.

Parameters

[out]

userName

The location of the device.

If the info object is obtained from a device that is already added (not through discovery), the username string value matches that of the device's "userName" property.

submitConfiguration()

void submitConfiguration ( const daq::PropertyObjectPtr &  config ) const

inline

Submits a new configuration for the network interface.

Parameters

config

The new configuration to apply.

Return values

OPENDAQ_SUCCESS

if the new configuration is applied successfully; otherwise, returns an informative error code.

The provided configuration must adhere to the required properties, including "dhcp4", "address4", "gateway4", and their IPv6 equivalents, as described in the class-level documentation.