OpenRTM-aist IDL  1.2
SDOPackage.idl
Go to the documentation of this file.
1 //Platform Independent Model (PIM) and Platform Specific Model (PSM)
2 //for Super Distributed Objects (SDO) Specification, v1.1 - OMG IDL Summary File
3 //Object Management Group, Inc.
4 //Copyright (c) 2003, Fraunhofer FOKUS
5 //Copyright (c) 2003, Hitachi, Ltd.
6 //The companies listed above have granted to the Object Management Group, Inc.
7 //(OMG) a nonexclusive, royalty-free, paid up, worldwide license to copy and
8 //distribute this document and to modify this document and distribute copies of
9 //the modified version. Each of the copyright holders listed above has agreed
10 //that no person shall be deemed to have infringed the copyright in the included
11 //material of any such copyright holder by reason of having used the
12 //specification set forth herein or having conformed any computer software to
13 //the specification.
14 //
15 //This file contains OMG IDL from the Naming Service Specification, v1.2.
16 //OMG regularly publishes a summary file that contains all the "code" parts of
17 //an OMG formal document. Every formal document line that is IDL, PIDL, or
18 //language code is included in the summary file. The reason for such a listing
19 //is to give readers an electronic version of the "code" so that they can
20 //extract pieces of it. Readers might want to test an example, include it in
21 //their own code, or use it for documentation purposes. Having the code lines
22 //available electronically means there is less likelihood of a transcription
23 //error.
24 //
25 // ver 1.0 formal/2004-11-02
26 // ver 1.1 (RTF report: dtc/2008-03-05)
27 //
28 //SDOPackage.idl
29 
30 #ifndef _SDO_PACKAGE_IDL_
31 #define _SDO_PACKAGE_IDL_
32 
33 #ifdef TAO_IDL
34 #include <orb.idl>
35 #endif
36 #ifdef USE_MONITORING
37 #include <CosNotifyComm.idl>
38 #endif
39 
42 #pragma prefix "org.omg"
43 #define exception_body { string description; }
44 
45 module SDOPackage
46 {
47  interface SDO;
48  interface SDOService;
49  interface SDOSystemElement;
50  interface Configuration;
51  interface Monitoring;
52  interface Organization;
53 
55  typedef sequence<string> StringList;
56  typedef sequence<SDO> SDOList;
57  typedef sequence<Organization> OrganizationList;
58  typedef string UniqueIdentifier;
59 
60  struct NameValue
61  {
62  string name;
63  any value;
64  };
65 
66  typedef sequence<NameValue> NVList;
67 
69  {
74  };
75 
76  union Numeric switch (NumericType)
77  {
78  case SHORT_TYPE: short short_value;
79  case LONG_TYPE: long long_value;
80  case FLOAT_TYPE: float float_value;
81  case DOUBLE_TYPE: double double_value;
82  };
83 
85  {
86  StringList enumerated_values;
87  };
88 
89  struct RangeType
90  {
93  boolean min_inclusive;
94  boolean max_inclusive;
95  };
96 
97  struct IntervalType
98  {
101  boolean min_inclusive;
102  boolean max_inclusive;
104  };
105 
107  {
109  };
110 
112  {
116  };
117 
118  struct Parameter
119  {
120  string name;
121 #ifdef __ORBIT_IDL__
122  TypeCode type;
123 #else
124  CORBA::TypeCode type;
125 #endif
127  };
128 
129  typedef sequence<Parameter> ParameterList;
131  {
132  NVList properties;
133  };
135  {
139  };
140 
142  {
143  string device_type;
144  string manufacturer;
145  string model;
146  string version;
147  NVList properties;
148  };
149 
151  {
152  string id;
154  NVList properties;
156  };
157 
158  typedef sequence <ServiceProfile> ServiceProfileList;
160  {
161  string id;
162  string description;
164  };
165 
166  typedef sequence<ConfigurationSet> ConfigurationSetList;
167 
168 
170  exception NotAvailable exception_body;
171  exception InterfaceNotImplemented exception_body;
172  exception InvalidParameter exception_body;
173  exception InternalError exception_body;
174 
177  {
178  OrganizationList get_owned_organizations()
179  raises (NotAvailable,InternalError);
180  };
181  interface SDO : SDOSystemElement
182  {
183  UniqueIdentifier get_sdo_id()
184  raises (NotAvailable, InternalError);
185  string get_sdo_type()
186  raises (NotAvailable, InternalError);
187  DeviceProfile get_device_profile ()
188  raises (NotAvailable, InternalError);
189  ServiceProfileList get_service_profiles ()
190  raises (NotAvailable, InternalError);
191  ServiceProfile get_service_profile (in UniqueIdentifier id)
192  raises (InvalidParameter, NotAvailable, InternalError);
193  SDOService get_sdo_service (in UniqueIdentifier id)
194  raises (InvalidParameter, NotAvailable, InternalError);
195  Configuration get_configuration ()
196  raises (InterfaceNotImplemented, NotAvailable, InternalError);
197  Monitoring get_monitoring ()
198  raises (InterfaceNotImplemented, NotAvailable, InternalError);
199  OrganizationList get_organizations ()
200  raises (NotAvailable, InternalError);
201  NVList get_status_list ()
202  raises (NotAvailable, InternalError);
203  any get_status (in string nme)
204  raises (InvalidParameter, NotAvailable, InternalError);
205  };
206 
207 
208  interface Configuration
209  {
210  boolean set_device_profile (in DeviceProfile dProfile)
211  raises (InvalidParameter, NotAvailable, InternalError);
212  boolean add_service_profile (in ServiceProfile sProfile)
213  raises (InvalidParameter, NotAvailable, InternalError);
214  boolean add_organization (in Organization organization_object)
215  raises (InvalidParameter, NotAvailable, InternalError);
216  boolean remove_service_profile (in UniqueIdentifier id)
217  raises (InvalidParameter, NotAvailable, InternalError);
218  boolean remove_organization (in UniqueIdentifier organization_id)
219  raises (InvalidParameter, NotAvailable, InternalError);
220  ParameterList get_configuration_parameters ()
221  raises (NotAvailable, InternalError);
222  NVList get_configuration_parameter_values ()
223  raises (NotAvailable, InternalError);
224  any get_configuration_parameter_value (in string name)
225  raises (InvalidParameter, NotAvailable, InternalError);
226  boolean set_configuration_parameter (in string name,
227  in any value)
228  raises (InvalidParameter, NotAvailable, InternalError);
229  ConfigurationSetList get_configuration_sets ()
230  raises (NotAvailable, InternalError);
231  ConfigurationSet get_configuration_set (in UniqueIdentifier config_id)
232  raises (NotAvailable, InternalError);
233  boolean set_configuration_set_values (in ConfigurationSet configuration_set)
234  raises (InvalidParameter, NotAvailable, InternalError);
235  ConfigurationSet get_active_configuration_set ()
236  raises (NotAvailable, InternalError);
237  boolean add_configuration_set (in ConfigurationSet configuration_set)
238  raises (InvalidParameter, NotAvailable, InternalError);
239  boolean remove_configuration_set (in UniqueIdentifier config_id)
240  raises (InvalidParameter, NotAvailable, InternalError);
241  boolean activate_configuration_set (in UniqueIdentifier config_id)
242  raises (InvalidParameter, NotAvailable, InternalError);
243  };
244 
245 
246 #ifdef USE_MONITORING
247  interface Monitoring : CosNotifyComm::StructuredPushConsumer,
248  CosNotifyComm::StructuredPushSupplier
249  {
250  any get_monitoring_parameter_value (in string name)
251  raises (InvalidParameter, NotAvailable, InternalError);
252  ParameterList get_monitoring_parameters ()
253  raises (NotAvailable, InternalError);
254  NVList get_monitoring_parameter_values ()
255  raises (NotAvailable, InternalError);
256  };
257 #else
258  interface Monitoring {};
259 #endif
260 
261  interface SDOService {};
262 
263  interface Organization
264  {
265  UniqueIdentifier get_organization_id ()
266  raises (InvalidParameter, NotAvailable, InternalError);
267  OrganizationProperty get_organization_property ()
268  raises (NotAvailable, InternalError);
269  any get_organization_property_value (in string name)
270  raises (InvalidParameter, NotAvailable, InternalError);
271  boolean add_organization_property (in OrganizationProperty organization_property)
272  raises (InvalidParameter, NotAvailable, InternalError);
273  boolean set_organization_property_value (in string name,
274  in any value)
275  raises (InvalidParameter, NotAvailable, InternalError);
276  boolean remove_organization_property ( in string name )
277  raises (InvalidParameter, NotAvailable, InternalError);
278  SDOSystemElement get_owner ()
279  raises (NotAvailable, InternalError);
280  boolean set_owner (in SDOSystemElement sdo)
281  raises (InvalidParameter, NotAvailable, InternalError);
282  SDOList get_members ()
283  raises (NotAvailable, InternalError);
284  boolean set_members (in SDOList sdos)
285  raises (InvalidParameter, NotAvailable, InternalError);
286  boolean add_members ( in SDOList sdo_list)
287  raises (InvalidParameter, NotAvailable, InternalError);
288  boolean remove_member (in UniqueIdentifier id)
289  raises (InvalidParameter, NotAvailable, InternalError);
290  DependencyType get_dependency()
291  raises (NotAvailable, InternalError);
292  boolean set_dependency (in DependencyType dependency)
293  raises (NotAvailable, InternalError);
294  };
295 };
296 #endif //_SDO_PACKAGE_IDL_
Definition: SDOPackage.idl:130
string UniqueIdentifier
Definition: SDOPackage.idl:58
sequence< Organization > OrganizationList
Definition: SDOPackage.idl:57
RangeType allowed_range
Definition: SDOPackage.idl:115
Numeric max
Definition: SDOPackage.idl:92
Definition: SDOPackage.idl:208
Definition: SDOPackage.idl:261
string name
Definition: SDOPackage.idl:120
sequence< ConfigurationSet > ConfigurationSetList
Definition: SDOPackage.idl:166
long long_value
Definition: SDOPackage.idl:79
float float_value
Definition: SDOPackage.idl:80
DependencyType
Definition: SDOPackage.idl:134
string device_type
Definition: SDOPackage.idl:143
Definition: SDOPackage.idl:60
NVList properties
Definition: SDOPackage.idl:147
string name
Definition: SDOPackage.idl:62
Definition: SDOPackage.idl:108
EnumerationType allowed_enum
Definition: SDOPackage.idl:113
Definition: SDOPackage.idl:72
sequence< SDO > SDOList
Definition: SDOPackage.idl:56
Definition: SDOPackage.idl:141
sequence< NameValue > NVList
Definition: SDOPackage.idl:66
Definition: SDOPackage.idl:70
boolean max_inclusive
Definition: SDOPackage.idl:94
CORBA::TypeCode type
Definition: SDOPackage.idl:124
Definition: SDOPackage.idl:181
string version
Definition: SDOPackage.idl:146
StringList enumerated_values
Definition: SDOPackage.idl:86
boolean min_inclusive
Definition: SDOPackage.idl:101
Numeric min
Definition: SDOPackage.idl:91
NumericType
Definition: SDOPackage.idl:68
Definition: SDOPackage.idl:159
Definition: SDOPackage.idl:263
Definition: SDOPackage.idl:45
ComplexDataType
Definition: SDOPackage.idl:106
Definition: SDOPackage.idl:89
#define exception_body
Definition: SDOPackage.idl:43
Numeric min
Definition: SDOPackage.idl:99
Definition: SDOPackage.idl:84
IntervalType allowed_interval
Definition: SDOPackage.idl:114
Definition: SDOPackage.idl:108
string manufacturer
Definition: SDOPackage.idl:144
double double_value
Definition: SDOPackage.idl:81
Definition: SDOPackage.idl:138
boolean max_inclusive
Definition: SDOPackage.idl:102
string interface_type
Definition: SDOPackage.idl:153
NVList properties
Definition: SDOPackage.idl:132
Definition: SDOPackage.idl:108
sequence< string > StringList
Definition: SDOPackage.idl:52
any value
Definition: SDOPackage.idl:63
Definition: SDOPackage.idl:71
SDOService service
Definition: SDOPackage.idl:155
NVList configuration_data
Definition: SDOPackage.idl:163
Definition: SDOPackage.idl:97
string id
Definition: SDOPackage.idl:161
Definition: SDOPackage.idl:176
sequence< ServiceProfile > ServiceProfileList
Definition: SDOPackage.idl:158
Numeric step
Definition: SDOPackage.idl:103
Definition: SDOPackage.idl:258
string id
Definition: SDOPackage.idl:152
string model
Definition: SDOPackage.idl:145
sequence< Parameter > ParameterList
Definition: SDOPackage.idl:129
string description
Definition: SDOPackage.idl:162
Definition: SDOPackage.idl:150
Definition: SDOPackage.idl:73
boolean min_inclusive
Definition: SDOPackage.idl:93
AllowedValues allowed_values
Definition: SDOPackage.idl:126
Definition: SDOPackage.idl:137
Numeric max
Definition: SDOPackage.idl:100
Definition: SDOPackage.idl:136
Definition: SDOPackage.idl:111
Definition: SDOPackage.idl:76
Definition: SDOPackage.idl:118
NVList properties
Definition: SDOPackage.idl:154
short short_value
Definition: SDOPackage.idl:78