Changeset 15045

Timestamp:

03/13/13 11:01:28 (12 years ago)

Author:

tbretz

Message:

Added two new commands getService and getServices.

File:

• trunk/FACT++/scripts/doc/dim.js (modified) (2 diffs)

trunk/FACT++/scripts/doc/dim.js

@@ -100 +100 @@
  *     is returned if a connection to the server is established and
  *     state information have been received, 'undefined' otherwise. If
- *     the time of the last state change is available it is stored
+ *     the time of the last state change is available, it is stored
  *     in the 'property'. If a server disconnected, a valid object will
  *     be returned, but without any properties.
@@ -161 +161 @@
  */
 dim.getStates = function() { /* [native code] */ }
+
+/**
+ *
+ * Returns a description for one service
+ *
+ * The returned array has objects with the properties: name, description and unit. The last
+ * two are optional. The array itself has the properties name, server, service, isCommand
+ * and optionally format.
+ *
+ * @param {String} [service]
+ *     String specifying the name of the service to be returned.
+ *
+ * @type Array[StringObject]
+ *
+ * @example
+ *     var s = dim.getServices("TNG_WEATHER/DATA");
+ *     console.out("Name="+s.name);
+ *     console.out("Server="+s.server);
+ *     console.out("Service="+s.service);
+ *     console.out("Format="+s.format);
+ *     console.out("Description="+s.name);
+ *     console.out("IsCommand="+s.isCommand);
+ *     console.out(JSON.stringify(s));
+ */
+dim.getServices = function() { /* [native code] */ }
+
+/**
+ *
+ * Returns a list of all known services
+ *
+ * The returned array has objects with the properties: name, server, service, command
+ * and (optional) format.
+ *
+ * @param {String} [service='*']
+ *     String a service has to start with to be returned. The default is to return
+ *     all available services. An empty string or '*' are wildcards for all
+ *     services.
+ *
+ * @param {Boolean} [isCommand]
+ *     If no second argument is specified, data services and commands are returned.
+ *     With true, only commands, with false, only data-services are returned.
+ *
+ * @type Array[Object]
+ *
+ * @example
+ *     // Return all services of the FAD_CONTROL starting with E
+ *     var services = dim.getServices("FAD_CONTROL/E");
+ *     console.out(JSON.stringify(services));
+ */
+dim.getServices = function() { /* [native code] */ }
 
 /**