imtdev::IEditableDeviceInstance

Interface for modifying device instance information. More...

#include <IEditableDeviceInstance.h>

Inheritance diagram for imtdev::IEditableDeviceInstance:

Public Member Functions
virtual bool	SetIdentifier (IdentifierTypes idType, const QByteArray &id)=0
	Set device identifier.
virtual bool	SetVersion (int versionId, quint32 version, const QString &description)=0
	Set device version information.
virtual iattr::IAttributesManager *	GetAttributesManager ()=0
	Get device instance attributes manager.
Public Member Functions inherited from imtdev::IDeviceInstance
virtual const IDeviceSpecification &	GetDeviceSpecification () const =0
	Get device static info associated with device instance.
virtual QByteArray	GetIdentifier (int identifierType) const =0
	Get the device identifier of the given type.
virtual const iser::IVersionInfo &	GetVersion () const =0
	Get device instance version information.
virtual const iattr::IAttributesProvider *	GetAttributes () const =0
	Get device instance attributes provider.

Additional Inherited Members
Public Types inherited from imtdev::IDeviceInstance
enum	IdentifierTypes { IT_SERIAL }
	Types of device identifiers. More...
enum	VersionIds {   VI_FIRMWARE_VERSION_MAJOR = iser::IVersionInfo::UserVersionId , VI_FIRMWARE_VERSION_MINOR , VI_FIRMWARE_VERSION_PATCH , VI_HARDWARE_VERSION_MAJOR ,   VI_HARDWARE_VERSION_MINOR , VI_HARDWARE_VERSION_PATCH }
	Version information identifiers. More...

Detailed Description

Interface for modifying device instance information.

IEditableDeviceInstance extends IDeviceInstance to provide mutable access to device instance properties. While IDeviceInstance provides read-only access, this interface allows modification of identifiers, version information, and attributes.

This interface is essential for:

• Initial device instance creation and configuration
• Updating device metadata after discovery
• Synchronizing instance data with physical device
• Managing dynamic attributes during runtime

Mutable Properties:

• Identifiers: Set device identifiers like serial numbers
• Version Information: Update firmware and hardware versions
• Attributes: Modify device-specific attributes via attributes manager

Usage Example:

// Typically obtained from device controller or factory
// For implementation reference:
CDeviceInstanceBase* pEditableInstance = // your instance
 
// Or obtained from controller with editable interface:
// EditableDeviceInstancePtr pEditableInstance = ...;
 
// Set device identifier (e.g., serial number)
QByteArray serialNumber = "SN123456789";
pEditableInstance->SetIdentifier(
       IDeviceInstance::IT_SERIAL, 
       serialNumber);
 
// Set firmware version
pEditableInstance->SetVersion(
       IDeviceInstance::VI_FIRMWARE_VERSION_MAJOR,
       2,
       "Major firmware version");
pEditableInstance->SetVersion(
       IDeviceInstance::VI_FIRMWARE_VERSION_MINOR,
       1,
       "Minor firmware version");
pEditableInstance->SetVersion(
       IDeviceInstance::VI_FIRMWARE_VERSION_PATCH,
       0,
       "Patch firmware version");
 
// Set hardware version
pEditableInstance->SetVersion(
       IDeviceInstance::VI_HARDWARE_VERSION_MAJOR,
       1,
       "Hardware revision");
 
// Access attributes manager to set device-specific attributes
iattr::IAttributesManager* pAttrMgr = 
       pEditableInstance->GetAttributesManager();
if (pAttrMgr)
{
       pAttrMgr->SetAttribute("DeviceTemperature", QVariant(25.5));
       pAttrMgr->SetAttribute("CalibrationDate", QVariant("2024-01-15"));
}
 
// Use as regular device instance (read-only access)
DeviceInstancePtr pInstance = pEditableInstance;
QByteArray id = pInstance->GetIdentifier(IDeviceInstance::IT_SERIAL);

Implementation Notes:

Implementations typically trigger change notifications when properties are modified, allowing observers to react to device instance updates.

See also

IDeviceInstance

CDeviceInstanceBase

IEditableCompositeDeviceInstance

Definition at line 93 of file IEditableDeviceInstance.h.

Member Function Documentation

GetAttributesManager()

virtual iattr::IAttributesManager * imtdev::IEditableDeviceInstance::GetAttributesManager ( )

pure virtual

Get device instance attributes manager.

Returns the attributes manager that provides mutable access to device instance attributes. Unlike GetAttributes() which returns read-only provider, this returns the manager interface for modifications.

Returns

Pointer to attributes manager

See also

IDeviceInstance::GetAttributes()

iattr::IAttributesManager

Implemented in imtdev::CDeviceInstanceBase.

SetIdentifier()

virtual bool imtdev::IEditableDeviceInstance::SetIdentifier ( IdentifierTypes  idType, const QByteArray &  id  )

pure virtual

Set device identifier.

Sets the device identifier of the specified type (e.g., serial number).

Parameters

idType	Type of identifier to set (e.g., IT_SERIAL)
id	Identifier value as a byte array

Returns

true if identifier was set successfully, false otherwise

See also

IDeviceInstance::GetIdentifier()

IDeviceInstance::IdentifierTypes

Implemented in imtdev::CDeviceInstanceBase.

SetVersion()

virtual bool imtdev::IEditableDeviceInstance::SetVersion ( int  versionId, quint32  version, const QString &  description  )

pure virtual

Set device version information.

Sets a version component (firmware or hardware version number) with an optional description.

Parameters

versionId	Version component identifier (e.g., VI_FIRMWARE_VERSION_MAJOR)
version	Version number value
description	Human-readable version description

Returns

true if version was set successfully, false otherwise

See also

IDeviceInstance::GetVersion()

IDeviceInstance::VersionIds

Implemented in imtdev::CDeviceInstanceBase.