Changeset 15045


Ignore:
Timestamp:
03/13/13 11:01:28 (9 years ago)
Author:
tbretz
Message:
Added two new commands getService and getServices.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/FACT++/scripts/doc/dim.js

    r14995 r15045  
    100100 *     is returned if a connection to the server is established and
    101101 *     state information have been received, 'undefined' otherwise. If
    102  *     the time of the last state change is available it is stored
     102 *     the time of the last state change is available, it is stored
    103103 *     in the 'property'. If a server disconnected, a valid object will
    104104 *     be returned, but without any properties.
     
    161161 */
    162162dim.getStates = function() { /* [native code] */ }
     163
     164/**
     165 *
     166 * Returns a description for one service
     167 *
     168 * The returned array has objects with the properties: name, description and unit. The last
     169 * two are optional. The array itself has the properties name, server, service, isCommand
     170 * and optionally format.
     171 *
     172 * @param {String} [service]
     173 *     String specifying the name of the service to be returned.
     174 *
     175 * @type Array[StringObject]
     176 *
     177 * @example
     178 *     var s = dim.getServices("TNG_WEATHER/DATA");
     179 *     console.out("Name="+s.name);
     180 *     console.out("Server="+s.server);
     181 *     console.out("Service="+s.service);
     182 *     console.out("Format="+s.format);
     183 *     console.out("Description="+s.name);
     184 *     console.out("IsCommand="+s.isCommand);
     185 *     console.out(JSON.stringify(s));
     186 */
     187dim.getServices = function() { /* [native code] */ }
     188
     189/**
     190 *
     191 * Returns a list of all known services
     192 *
     193 * The returned array has objects with the properties: name, server, service, command
     194 * and (optional) format.
     195 *
     196 * @param {String} [service='*']
     197 *     String a service has to start with to be returned. The default is to return
     198 *     all available services. An empty string or '*' are wildcards for all
     199 *     services.
     200 *
     201 * @param {Boolean} [isCommand]
     202 *     If no second argument is specified, data services and commands are returned.
     203 *     With true, only commands, with false, only data-services are returned.
     204 *
     205 * @type Array[Object]
     206 *
     207 * @example
     208 *     // Return all services of the FAD_CONTROL starting with E
     209 *     var services = dim.getServices("FAD_CONTROL/E");
     210 *     console.out(JSON.stringify(services));
     211 */
     212dim.getServices = function() { /* [native code] */ }
    163213
    164214/**
Note: See TracChangeset for help on using the changeset viewer.