Configuration component of Device info objects. Contains setter methods that are available until the object is frozen. More...

Inheritance diagram for IDeviceInfoConfig:

Collaboration diagram for IDeviceInfoConfig:

Detailed Description

Configuration component of Device info objects. Contains setter methods that are available until the object is frozen.

Device info config contains functions that allow for the configuration of Device info objects. The implementation of config also implements the freeze function that freezes the object making it immutable. Once frozen, the setter methods fail as the object can no longer be modified.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets the name of the device. More...

virtual ErrCode INTERFACE_FUNC	setConnectionString (IString *connectionString)=0
	Sets the string representation of a connection address used to connect to the device. More...

virtual ErrCode INTERFACE_FUNC	setDeviceType (IDeviceType *deviceType)=0
	Sets a device type as an object providing type id, name, short description and default device configuration. More...

virtual ErrCode INTERFACE_FUNC	setManufacturer (IString *manufacturer)=0
	Sets the company that manufactured the device. More...

virtual ErrCode INTERFACE_FUNC	setManufacturerUri (IString *manufacturerUri)=0
	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...

virtual ErrCode INTERFACE_FUNC	setModel (IString *model)=0
	Sets the model of the device. More...

virtual ErrCode INTERFACE_FUNC	setProductCode (IString *productCode)=0
	Sets the unique combination of numbers and letters used to identify the device. More...

virtual ErrCode INTERFACE_FUNC	setDeviceRevision (IString *deviceRevision)=0
	Sets the revision level of the device. More...

virtual ErrCode INTERFACE_FUNC	setHardwareRevision (IString *hardwareRevision)=0
	Sets the revision level of the hardware. More...

virtual ErrCode INTERFACE_FUNC	setSoftwareRevision (IString *softwareRevision)=0
	sets the revision level of the software component More...

virtual ErrCode INTERFACE_FUNC	setDeviceManual (IString *deviceManual)=0
	Sets the address of the user manual. It may be a pathname in the file system or a URL (Web address) More...

virtual ErrCode INTERFACE_FUNC	setDeviceClass (IString *deviceClass)=0
	Sets the purpose of the device. For example "TestMeasurementDevice". More...

virtual ErrCode INTERFACE_FUNC	setSerialNumber (IString *serialNumber)=0
	Sets the serial number of the device. More...

virtual ErrCode INTERFACE_FUNC	setProductInstanceUri (IString *productInstanceUri)=0
	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...

virtual ErrCode INTERFACE_FUNC	setRevisionCounter (Int revisionCounter)=0
	Sets the incremental counter indicating the number of times the configuration data has been modified. More...

virtual ErrCode INTERFACE_FUNC	setAssetId (IString *id)=0
	Sets the asset ID of the device. Represents a user writable alphanumeric character sequence uniquely identifying a component. More...

virtual ErrCode INTERFACE_FUNC	setMacAddress (IString *macAddress)=0
	Sets the Mac address of the device. More...

virtual ErrCode INTERFACE_FUNC	setParentMacAddress (IString *macAddress)=0
	Sets the Mac address of the device's parent. More...

virtual ErrCode INTERFACE_FUNC	setPlatform (IString *platform)=0
	Sets the platform of the device. The platform specifies whether real hardware is used or if the device is simulated. More...

virtual ErrCode INTERFACE_FUNC	setPosition (Int position)=0
	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...

virtual ErrCode INTERFACE_FUNC	setSystemType (IString *type)=0
	Sets the system type. The system type can, for example, be LayeredSystem, StandaloneSystem, or RackSystem. More...

virtual ErrCode INTERFACE_FUNC	setSystemUuid (IString *uuid)=0
	Sets the system UUID that represents a unique ID of a system. All devices in a system share this UUID. More...

virtual ErrCode INTERFACE_FUNC	setLocation (IString *location)=0
	Sets the device's location. More...

Public Member Functions inherited from IDeviceInfo
virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the name of the device. More...

virtual ErrCode INTERFACE_FUNC	getConnectionString (IString **connectionString)=0
	Gets the string representation of a connection address used to connect to the device. More...

virtual ErrCode INTERFACE_FUNC	getDeviceType (IDeviceType **deviceType)=0
	Gets a device type as an object providing type id, name, short description and default device configuration. By using default config object as a starting point, users can easily modify the preset properties to tailor the configuration of the client device accordingly. More...

virtual ErrCode INTERFACE_FUNC	getManufacturer (IString **manufacturer)=0
	Gets the company that manufactured the device. More...

virtual ErrCode INTERFACE_FUNC	getManufacturerUri (IString **manufacturerUri)=0
	Gets 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...

virtual ErrCode INTERFACE_FUNC	getModel (IString **model)=0
	Gets the model of the device. More...

virtual ErrCode INTERFACE_FUNC	getProductCode (IString **productCode)=0
	Gets the unique combination of numbers and letters used to identify the device. More...

virtual ErrCode INTERFACE_FUNC	getDeviceRevision (IString **deviceRevision)=0
	Gets the revision level of the device. More...

virtual ErrCode INTERFACE_FUNC	getHardwareRevision (IString **hardwareRevision)=0
	Gets the revision level of the hardware. More...

virtual ErrCode INTERFACE_FUNC	getSoftwareRevision (IString **softwareRevision)=0
	Gets the revision level of the software component. More...

virtual ErrCode INTERFACE_FUNC	getDeviceManual (IString **deviceManual)=0
	Gets the address of the user manual. It may be a pathname in the file system or a URL (Web address) More...

virtual ErrCode INTERFACE_FUNC	getDeviceClass (IString **deviceClass)=0
	Gets the purpose of the device. For example "TestMeasurementDevice". More...

virtual ErrCode INTERFACE_FUNC	getSerialNumber (IString **serialNumber)=0
	Gets the unique production number provided by the manufacturer. More...

virtual ErrCode INTERFACE_FUNC	getProductInstanceUri (IString **productInstanceUri)=0
	Gets 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...

virtual ErrCode INTERFACE_FUNC	getRevisionCounter (Int *revisionCounter)=0
	Gets the incremental counter indicating the number of times the configuration data has been modified. More...

virtual ErrCode INTERFACE_FUNC	getAssetId (IString **id)=0
	Gets the asset ID of the device. Represents a user writable alphanumeric character sequence uniquely identifying a component. More...

virtual ErrCode INTERFACE_FUNC	getMacAddress (IString **macAddress)=0
	Gets the Mac address of the device. More...

virtual ErrCode INTERFACE_FUNC	getParentMacAddress (IString **macAddress)=0
	Gets the Mac address of the device's parent. More...

virtual ErrCode INTERFACE_FUNC	getPlatform (IString **platform)=0
	Gets the platform of the device. The platform specifies whether real hardware is used or if the device is simulated. More...

virtual ErrCode INTERFACE_FUNC	getPosition (Int *position)=0
	Gets 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...

virtual ErrCode INTERFACE_FUNC	getSystemType (IString **type)=0
	Gets the system type. The system type can, for example, be LayeredSystem, StandaloneSystem, or RackSystem. More...

virtual ErrCode INTERFACE_FUNC	getSystemUuid (IString **uuid)=0
	Gets the system UUID that represents a unique ID of a system. All devices in a system share this UUID. More...

virtual ErrCode INTERFACE_FUNC	getCustomInfoPropertyNames (IList **customInfoNames)=0
	Gets the list of property names that are not in the default set of Device info properties. Default properties are all info properties that have a corresponding getter method. More...

virtual ErrCode INTERFACE_FUNC	getSdkVersion (IString **version)=0
	Gets the version of the SDK used to build said device. Can be empty if the device does not use the SDK as its firmware/is implemented at a protocol-level. More...

virtual ErrCode INTERFACE_FUNC	getServerCapabilities (IList **serverCapabilities)=0
	Gets the list of server capabilities stored in device info. More...

virtual ErrCode INTERFACE_FUNC	getLocation (IString **location)=0
	Gets the location of the device. More...

virtual ErrCode INTERFACE_FUNC	getConfigurationConnectionInfo (IServerCapability **connectionInfo)=0
	Retrieves the configuration connection information of the server to which the client is connected. More...

virtual ErrCode INTERFACE_FUNC	hasServerCapability (IString protocolId, Bool hasCapability)=0
	Checks whether the server capability with a given ID is available. More...

virtual ErrCode INTERFACE_FUNC	getServerCapability (IString protocolId, IServerCapability *serverCapability)=0
	Gets the server capability with a given ID. More...

Public Member Functions inherited from IPropertyObject
virtual ErrCode INTERFACE_FUNC	getClassName (IString **className)=0
	Gets the name of the class the Property object was constructed with. More...

virtual ErrCode INTERFACE_FUNC	setPropertyValue (IString propertyName, IBaseObject value)=0
	Sets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertyValue (IString propertyName, IBaseObject *value)=0
	Gets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertySelectionValue (IString propertyName, IBaseObject *value)=0
	Gets the selected value of the Property, if the Property is a Selection property. More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValue (IString *propertyName)=0
	Clears the Property value from the Property object. More...

virtual ErrCode INTERFACE_FUNC	hasProperty (IString propertyName, Bool hasProperty)=0
	Checks if the Property object contains a property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getProperty (IString propertyName, IProperty *property)=0
	Gets the Property with the given `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	addProperty (IProperty *property)=0
	Adds the property to the Property object. More...

virtual ErrCode INTERFACE_FUNC	removeProperty (IString *propertyName)=0
	Removes the Property named `propertyName` from the Property object. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueWrite (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value is written to the Property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueRead (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value of a Property named `propertyName` is read. More...

virtual ErrCode INTERFACE_FUNC	getVisibleProperties (IList **properties)=0
	Returns a list of visible properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	getAllProperties (IList **properties)=0
	Returns a list of all properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	setPropertyOrder (IList *orderedPropertyNames)=0
	Sets a custom order of properties as defined in the list of property names. More...

virtual ErrCode INTERFACE_FUNC	beginUpdate ()=0
	Begins batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	endUpdate ()=0
	Ends batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	getUpdating (Bool *updating)=0
	Returns the state of batch configuration. More...

virtual ErrCode INTERFACE_FUNC	getOnEndUpdate (IEvent **event)=0
	Gets the Event that is triggered whenever the batch configuration is applied. More...

virtual ErrCode INTERFACE_FUNC	getPermissionManager (IPermissionManager **permissionManager)=0
	Gets the permission manager of property object. More...

Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...

virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...

virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...

virtual ErrCode INTERFACE_FUNC	equals (IBaseObject other, Bool equal) const =0
	Compares object to another object for equality. More...

virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...

Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...

virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...

virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

◆ setAssetId()

virtual ErrCode INTERFACE_FUNC setAssetId ( IString * id )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setConnectionString ( IString * connectionString )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setDeviceClass ( IString * deviceClass )

pure virtual

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

Parameters

deviceClass The class of the device.

◆ setDeviceManual()

virtual ErrCode INTERFACE_FUNC setDeviceManual ( IString * deviceManual )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setDeviceRevision ( IString * deviceRevision )

pure virtual

Sets the revision level of the device.

Parameters

deviceRevision The device revision level.

◆ setDeviceType()

virtual ErrCode INTERFACE_FUNC setDeviceType ( IDeviceType * deviceType )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setHardwareRevision ( IString * hardwareRevision )

pure virtual

Sets the revision level of the hardware.

Parameters

hardwareRevision The hardware revision of the device.

◆ setLocation()

virtual ErrCode INTERFACE_FUNC setLocation ( IString * location )

pure virtual

Sets the device's location.

Parameters

location The device's location.

◆ setMacAddress()

virtual ErrCode INTERFACE_FUNC setMacAddress ( IString * macAddress )

pure virtual

Sets the Mac address of the device.

Parameters

macAddress The Mac address.

◆ setManufacturer()

virtual ErrCode INTERFACE_FUNC setManufacturer ( IString * manufacturer )

pure virtual

Sets the company that manufactured the device.

Parameters

manufacturer The manufacturer of the device.

◆ setManufacturerUri()

virtual ErrCode INTERFACE_FUNC setManufacturerUri ( IString * manufacturerUri )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setModel ( IString * model )

pure virtual

Sets the model of the device.

Parameters

model The model of the device.

◆ setName()

virtual ErrCode INTERFACE_FUNC setName ( IString * name )

pure virtual

Sets the name of the device.

Parameters

name	The name of the device.

◆ setParentMacAddress()

virtual ErrCode INTERFACE_FUNC setParentMacAddress ( IString * macAddress )

pure virtual

Sets the Mac address of the device's parent.

Parameters

macAddress The parent's Mac address.

◆ setPlatform()

virtual ErrCode INTERFACE_FUNC setPlatform ( IString * platform )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setPosition ( Int position )

pure virtual

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 platform of the device.

◆ setProductCode()

virtual ErrCode INTERFACE_FUNC setProductCode ( IString * productCode )

pure virtual

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

Parameters

productCode The product code of the device.

◆ setProductInstanceUri()

virtual ErrCode INTERFACE_FUNC setProductInstanceUri ( IString * productInstanceUri )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setRevisionCounter ( Int revisionCounter )

pure virtual

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

Parameters

revisionCounter The revision counter of the device.

◆ setSerialNumber()

virtual ErrCode INTERFACE_FUNC setSerialNumber ( IString * serialNumber )

pure virtual

Sets the serial number of the device.

Parameters

serialNumber The serial number of the device.

◆ setSoftwareRevision()

virtual ErrCode INTERFACE_FUNC setSoftwareRevision ( IString * softwareRevision )

pure virtual

sets the revision level of the software component

Parameters

softwareRevision The software revision of the device.

◆ setSystemType()

virtual ErrCode INTERFACE_FUNC setSystemType ( IString * type )

pure virtual

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

Parameters

type	The system type of the device.

◆ setSystemUuid()

virtual ErrCode INTERFACE_FUNC setSystemUuid ( IString * uuid )

pure virtual

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.

	openDAQ Open data acquisition platform

Detailed Description

Public Member Functions

Member Function Documentation

◆ setAssetId()

◆ setConnectionString()

◆ setDeviceClass()

◆ setDeviceManual()

◆ setDeviceRevision()

◆ setDeviceType()

◆ setHardwareRevision()

◆ setLocation()

◆ setMacAddress()

◆ setManufacturer()

◆ setManufacturerUri()

◆ setModel()

◆ setName()

◆ setParentMacAddress()

◆ setPlatform()

◆ setPosition()

◆ setProductCode()

◆ setProductInstanceUri()

◆ setRevisionCounter()

◆ setSerialNumber()

◆ setSoftwareRevision()

◆ setSystemType()

◆ setSystemUuid()