DeviceInfoConfigPtr Class Reference

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

Inheritance diagram for DeviceInfoConfigPtr:

Collaboration diagram for DeviceInfoConfigPtr:

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
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...
Public Member Functions inherited from GenericDeviceInfoPtr< IDeviceInfoConfig >
daq::StringPtr	getName () const
	Gets the name of the device. More...
daq::StringPtr	getConnectionString () const
	Gets the string representation of a connection address used to connect to the device. More...
daq::GenericDeviceTypePtr< daq::IDeviceType >	getDeviceType () const
	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...
daq::StringPtr	getManufacturer () const
	Gets the company that manufactured the device. More...
daq::StringPtr	getManufacturerUri () const
	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...
daq::StringPtr	getModel () const
	Gets the model of the device. More...
daq::StringPtr	getProductCode () const
	Gets the unique combination of numbers and letters used to identify the device. More...
daq::StringPtr	getDeviceRevision () const
	Gets the revision level of the device. More...
daq::StringPtr	getHardwareRevision () const
	Gets the revision level of the hardware. More...
daq::StringPtr	getSoftwareRevision () const
	Gets the revision level of the software component. More...
daq::StringPtr	getDeviceManual () const
	Gets the address of the user manual. It may be a pathname in the file system or a URL (Web address) More...
daq::StringPtr	getDeviceClass () const
	Gets the purpose of the device. For example "TestMeasurementDevice". More...
daq::StringPtr	getSerialNumber () const
	Gets the unique production number provided by the manufacturer. More...
daq::StringPtr	getProductInstanceUri () const
	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...
daq::Int	getRevisionCounter () const
	Gets the incremental counter indicating the number of times the configuration data has been modified. More...
daq::StringPtr	getAssetId () const
	Gets the asset ID of the device. Represents a user writable alphanumeric character sequence uniquely identifying a component. More...
daq::StringPtr	getMacAddress () const
	Gets the Mac address of the device. More...
daq::StringPtr	getParentMacAddress () const
	Gets the Mac address of the device's parent. More...
daq::StringPtr	getPlatform () const
	Gets the platform of the device. The platform specifies whether real hardware is used or if the device is simulated. More...
daq::Int	getPosition () const
	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...
daq::StringPtr	getSystemType () const
	Gets the system type. The system type can, for example, be LayeredSystem, StandaloneSystem, or RackSystem. More...
daq::StringPtr	getSystemUuid () const
	Gets the system UUID that represents a unique ID of a system. All devices in a system share this UUID. More...
daq::ListPtr< daq::IString >	getCustomInfoPropertyNames () const
	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...
daq::StringPtr	getSdkVersion () const
	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...
daq::ListPtr< daq::IServerCapability >	getServerCapabilities () const
	Gets the list of server capabilities stored in device info. More...
daq::StringPtr	getLocation () const
	Gets the location of the device. More...
daq::ServerCapabilityPtr	getConfigurationConnectionInfo () const
	Retrieves the configuration connection information of the server to which the client is connected. More...
daq::Bool	hasServerCapability (const daq::StringPtr &protocolId) const
	Checks whether the server capability with a given ID is available. More...
daq::ServerCapabilityPtr	getServerCapability (const daq::StringPtr &protocolId) const
	Gets the server capability with a given ID. More...
daq::DictPtr< daq::IString, daq::INetworkInterface >	getNetworkInterfaces () const
	Gets the dictionary of network interfaces stored in device info. More...
daq::NetworkInterfacePtr	getNetworkInterface (const daq::StringPtr &interfaceName) const
	Gets the network interface with a given name. More...
daq::StringPtr	getUserName () const
	Gets the name of the current user of the device. More...
daq::ListPtr< daq::IConnectedClientInfo >	getConnectedClientsInfo () const
	Gets the list of connected client information objects. More...
Public Member Functions inherited from GenericPropertyObjectPtr< InterfaceType >
daq::StringPtr	getClassName () const
	Gets the name of the class the Property object was constructed with. More...
void	setPropertyValue (const daq::StringPtr &propertyName, const daq::BaseObjectPtr &value) const
	Sets the value of the Property with the given name. More...
daq::BaseObjectPtr	getPropertyValue (const daq::StringPtr &propertyName) const
	Gets the value of the Property with the given name. More...
daq::BaseObjectPtr	getPropertySelectionValue (const daq::StringPtr &propertyName) const
	Gets the selected value of the Property, if the Property is a Selection property. More...
void	clearPropertyValue (const daq::StringPtr &propertyName) const
	Clears the Property value from the Property object. More...
daq::Bool	hasProperty (const daq::StringPtr &propertyName) const
	Checks if the Property object contains a property named propertyName. More...
daq::PropertyPtr	getProperty (const daq::StringPtr &propertyName) const
	Gets the Property with the given propertyName. More...
void	addProperty (const daq::PropertyPtr &property) const
	Adds the property to the Property object. More...
void	removeProperty (const daq::StringPtr &propertyName) const
	Removes the Property named propertyName from the Property object. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnPropertyValueWrite (const daq::StringPtr &propertyName) const
	Gets the Event that is triggered whenever a Property value is written to the Property named propertyName. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnPropertyValueRead (const daq::StringPtr &propertyName) const
	Gets the Event that is triggered whenever a Property value of a Property named propertyName is read. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnAnyPropertyValueWrite () const
	Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnAnyPropertyValueRead () const
	Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. More...
daq::ListPtr< daq::IProperty >	getVisibleProperties () const
	Returns a list of visible properties contained in the Property object. More...
daq::ListPtr< daq::IProperty >	getAllProperties () const
	Returns a list of all properties contained in the Property object. More...
void	setPropertyOrder (const daq::ListPtr< daq::IString > &orderedPropertyNames) const
	Sets a custom order of properties as defined in the list of property names. More...
void	beginUpdate () const
	Begins batch configuration of the object. More...
void	endUpdate () const
	Ends batch configuration of the object. More...
daq::Bool	getUpdating () const
	Returns the state of batch configuration. More...
daq::Event< daq::PropertyObjectPtr, daq::EndUpdateEventArgsPtr >	getOnEndUpdate () const
	Gets the Event that is triggered whenever the batch configuration is applied. More...
daq::PermissionManagerPtr	getPermissionManager () const
	Gets the permission manager of property object. More...