This is historical information of device classes implemented in HdbConfiguratorServer device server.
Use this link to find the valid information.
Development status:
Released
Information status: New
Contact:
Class Description
This class is able to use HdbConfigurator classes to Add/Start/Stop archiving attributes on HDB++ subscribers. It uses call on HdbConfiguratorServer device.
Families: System
Key words: Archiving,Archiving,Archiving,Archiving,Archiving,Archiving,Archiving,Archiving,Archiving,Archiving
Platform: All Platforms
Language: Java
License: GPL
Contact:
Hardware
Manufacturer: none
Bus: Not Applicable
Class interface
Attributes:
| Name | Description |
|---|---|
| HdbManagerDeviceNameScalar: DevString | Returns the manager device name |
| ArchiverListSpectrum: DevString | Managed archiver list |
| ArchiverAliasListSpectrum: DevString | Managed archiver alias list |
Commands:
| Name | Description |
|---|---|
| StateInput: DevVoid Output: State Device state |
This command gets the device state (stored in its device_state data member) and returns it to the caller. |
| StatusInput: DevVoid Output: ConstDevString Device status |
This command gets the device status (stored in its device_status data member) and returns it to the caller. |
| AddAttributesInput: DevVarStringArray [0] - Subscriber name. [1] - Attribute 1 name. [2] - Attribute 2 name. - - - - - [n] - Attribute n name. [n+1] - true/false for using push event (false if not specified) Output: DevLong ID number. Usefull to get information later. |
Add specified attributes to the specified subscriber attribute list if not already done and start archiving. Due to a possible dead lock, during this command execution and the event subscribing, this subscription will delayed and done by a thread. To avoid a bottle neck for this command execution, the subscriptions will be serialized. That means that it could takes several seconds. Use AddingState and AddingStatus commands to know if subscriptions are done without problem. |
| AddingStateInput: DevLong ID returns by AddAttributes command Output: State ON if adding has been done. ALARM if at least one have failed. MOVING if adding is not finished. |
Returns the AddingAttributes command state. |
| AddingStatusInput: DevLong ID returns by AddAttributes command Output: DevString Return AddAttributes command error message if any. |
Returns the AddingAttributes command status. |
| AttributeIsManagedInput: DevString Attribute name Output: DevBoolean true if attribute managed. False otherwise. |
Check if the specified attribute is managed by a subscriber. If not, use AddAttributes command to set it managed. |
| AttributeStartedInput: DevString Specified attribute name. Output: DevBoolean true if archiving is started |
Check if attribute archiving is started |
| AttributePausedInput: DevString Specified attribute name. Output: DevBoolean true if archiving is paused |
Check if attribute archiving is paused |
| AttributeStoppedInput: DevString Specified attribute name. Output: DevBoolean true if archiving is stopped |
Check if attribute archiving is stopped |
| AttributeGetArchiverInput: DevString Specified attriute name. Output: DevString The subscriber name. |
Returns the subscriber name for specified attribute. |
| AttributeGetArchiverAliasInput: DevString Specified attriute alias. Output: DevString The subscriber name. |
Returns the subscriber alias for specified attribute. |
| StartArchivingInput: DevVarStringArray Attribute names to be started. Output: DevVoid |
Start archiving for specified attributes. |
| StopArchivingInput: DevVarStringArray Attribute names to be stopped. Output: DevVoid |
Stop archiving for specified attributes. |
| RemoveAttributesInput: DevVarStringArray Attribute list to be removed Output: DevVoid |
Stop archiving if necessary and remove attributes from subscriber list |
Pipes:
Properties:
| Name | Description |
|---|---|
| HdbManagerDevString | The HDB++ manager device name (HdbConfiguratorServer class). This property is mandatory |
| WaitingTimeDevLong | Waiting time before trying to add attributes to HDB++ in seconds |
Updated:
The device class has been updated.
You can see previous version here .
19 Jan 2017, Piotr Goryl
Updated:
The device server has been updated.
You are looking at this version now.
2 Jan 2017, Piotr Goryl
Created:
The device server has been added to catalogue.