source: trunk/FACT++/scripts/doc/Description.js@ 20052

Last change on this file since 20052 was 19461, checked in by tbretz, 6 years ago
Was missing
File size: 1.9 KB
Line 
1throw new Error("Description for built in functions. Must not be included!");
2/**
3 * @fileOverview
4 * Documentation of the Event object returned by Subscription.get()
5 */
6
7/**
8 * @class
9 *
10 * The object stores the returned data of dim.getDescription(). This object
11 * is essentially an array. Each entry can store the property name, description
12 * and unit.
13 *
14 */
15function Description()
16{
17 /**
18 * The name of the service the object belongs to, e.g. RATE_CONTROL/THRESHOLD
19 *
20 * @type String
21 * @constant
22 */
23 this.name = name;
24
25 /**
26 * The server name of the service the object belongs to, e.g. RATE_CONTROL.
27 * (if no description data is available this might be undefined)
28 *
29 * @type String
30 * @constant
31 * @default undefined
32 */
33 this.server = server;
34
35 /**
36 * The service of the service the object belongs to, e.g. THRESHOLD
37 * (if no description data is available this might be undefined)
38 *
39 * @type String
40 * @constant
41 * @default undefined
42 */
43 this.service = service;
44
45 /**
46 * If available, a global description of this service.
47 *
48 * @type String
49 * @constant
50 * @default undefined
51 */
52 this.description = description;
53
54 /**
55 * If available, the format string corresponding to this service.
56 *
57 * @see <A HREF="dim.cern.ch">DIM</A> for more details
58 * @type String
59 * @constant
60 * @default undefined
61 */
62 this.format = format;
63
64 /**
65 * true if this service is a command, false if it is a data-service
66 *
67 * @type Boolean
68 * @constant
69 * @default undefined
70 */
71 this.isCommand = is_command;
72
73 /**
74 * The number of entries, i.e. descriptions of individual arguments of the service
75 * (if no description data is available this might be undefined)
76 *
77 * @type Integer
78 * @constant
79 */
80 this.length = length;
81
82}
Note: See TracBrowser for help on using the repository browser.