1 | Library |
---|
2 | |
---|
3 | constructors/destructors |
---|
4 | Library() |
---|
5 | Library(const Library& o) |
---|
6 | ~Library () |
---|
7 | |
---|
8 | methods |
---|
9 | Outcome &loadXml(const char *xmltext) |
---|
10 | Outcome &loadFile(const char *filename) |
---|
11 | |
---|
12 | |
---|
13 | Library &value(const char *key, void *storage, |
---|
14 | size_t numHints, ...) |
---|
15 | |
---|
16 | Rp_Chain *diff(Library *lib) |
---|
17 | |
---|
18 | Library &remove (const char *key) |
---|
19 | |
---|
20 | const char *xml() const |
---|
21 | |
---|
22 | Outcome &outcome() const |
---|
23 | int error() const |
---|
24 | |
---|
25 | Outcome &result(int status) |
---|
26 | |
---|
27 | const Rp_Chain *contains() const |
---|
28 | |
---|
29 | --------------------------------------- |
---|
30 | |
---|
31 | Outcome &loadXml(const char *xmltext) |
---|
32 | Purpose: parse the Rappture1.1 xml data in "xmltext". |
---|
33 | populate this library object with the Rappture |
---|
34 | objects described in the xml data. |
---|
35 | Input Arguments: 1 |
---|
36 | 1. const char *xmltext - Rappture1.1 xml data |
---|
37 | Return Value: status of the object |
---|
38 | Notes: None |
---|
39 | Code Example: |
---|
40 | |
---|
41 | Outcome &loadFile(const char *filename); |
---|
42 | Purpose: read the file "filename" and parse the |
---|
43 | Rappture1.1 xml data found inside of it. |
---|
44 | populate this library object with the Rappture |
---|
45 | objects described in the xml data. |
---|
46 | Input Arguments: 1 |
---|
47 | 1. const char *filename - file containing Rappture1.1 |
---|
48 | xml data |
---|
49 | Return Value: status of the object |
---|
50 | Notes: None |
---|
51 | Code Example: |
---|
52 | |
---|
53 | Library &value(const char *key, void *storage, |
---|
54 | size_t numHints, ...); |
---|
55 | Purpose: retrieve the value of the object named "key" and |
---|
56 | store it in "storage". If there are hints, |
---|
57 | pass them along to the object being retrieved |
---|
58 | to tell it how the value should be configured. |
---|
59 | Input Arguments: at least 3 |
---|
60 | 1. const char *key - name of the object being retrieved |
---|
61 | 2. void *storage - where to place the value of the |
---|
62 | retrieved object |
---|
63 | 3. size_t numHints - number of hints provided |
---|
64 | 4. ... - hints listed as strings |
---|
65 | Return Value: None |
---|
66 | Notes: hints are listed as strings of the form |
---|
67 | "hintKey=hintVal". hintKey is the key for the hint |
---|
68 | and hintVal is the value to be applied to the hint. |
---|
69 | generally, unrecognized hints are ignored. the hints |
---|
70 | should be listed as comma separated strings in the |
---|
71 | function's argument list. |
---|
72 | Code Example: |
---|
73 | |
---|
74 | Rp_Chain *diff(Library *lib); |
---|
75 | Purpose: find the difference between two library objects |
---|
76 | Input Arguments: 1 |
---|
77 | 1. Library *lib - other object used in comparison |
---|
78 | Return Value: Linked list of differences |
---|
79 | Notes: None |
---|
80 | Code Example: |
---|
81 | |
---|
82 | Library &remove (const char *key); |
---|
83 | Purpose: remove the object from this library named "key" |
---|
84 | Input Arguments: 1 |
---|
85 | 1. const char *key - name of the object to remove |
---|
86 | Return Value: None |
---|
87 | Notes: The object is removed and it's memory is deleted |
---|
88 | Code Example: |
---|
89 | |
---|
90 | const char *xml() const; |
---|
91 | Purpose: return the Rappture1.1 xml representation of the |
---|
92 | objects stored in this library. |
---|
93 | Input Arguments: 0 |
---|
94 | Return Value: None |
---|
95 | Notes: user is responsible for free'ing returned memory? |
---|
96 | Code Example: |
---|
97 | |
---|
98 | Outcome &outcome() const; |
---|
99 | Purpose: return the status of the object |
---|
100 | Input Arguments: 0 |
---|
101 | Return Value: status of the object |
---|
102 | Notes: None |
---|
103 | Code Example: |
---|
104 | |
---|
105 | int error() const; |
---|
106 | Purpose: return the status of the object |
---|
107 | Input Arguments: 0 |
---|
108 | Return Value: status of the object |
---|
109 | Notes: None |
---|
110 | Code Example: |
---|
111 | |
---|
112 | Outcome &result(int status); |
---|
113 | Purpose: write the stored objects to a data file and |
---|
114 | signal the end of processing. |
---|
115 | Input Arguments: 1 |
---|
116 | 1. int status - status of the simulation |
---|
117 | Return Value: None |
---|
118 | Notes: currently data file are written out as Rappture1.1 |
---|
119 | xml. this function generates the RAPPTURE-RUN=> |
---|
120 | signal. |
---|
121 | Code Example: |
---|
122 | |
---|
123 | const Rp_Chain *contains() const; |
---|
124 | Purpose: return a linked list of the Rappture objects |
---|
125 | stored in this library. |
---|
126 | Input Arguments: 0 |
---|
127 | Return Value: linked list of the Rappture objects stored in |
---|
128 | this library. |
---|
129 | Notes: None |
---|
130 | Code Example: |
---|