OpenRTM  1.0.0
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 #ifndef ORBIT2_IDL
40 #define TypeCode CORBA::TypeCode
41 #endif
42 
44 #pragma prefix "org.omg"
45 #define exception_body { string description; }
46 
47 module SDOPackage
48 {
49  interface SDO;
50  interface SDOService;
51  interface SDOSystemElement;
52  interface Configuration;
53  interface Monitoring;
54  interface Organization;
55 
57  typedef sequence<string> StringList;
58  typedef sequence<SDO> SDOList;
59  typedef sequence<Organization> OrganizationList;
60  typedef string UniqueIdentifier;
61 
62  struct NameValue
63  {
64  string name;
65  any value;
66  };
67 
68  typedef sequence<NameValue> NVList;
69 
71  {
76  };
77 
78  union Numeric switch (NumericType)
79  {
80  case SHORT_TYPE: short short_value;
81  case LONG_TYPE: long long_value;
82  case FLOAT_TYPE: float float_value;
83  case DOUBLE_TYPE: double double_value;
84  };
85 
87  {
88  StringList enumerated_values;
89  };
90 
91  struct RangeType
92  {
95  boolean min_inclusive;
96  boolean max_inclusive;
97  };
98 
99  struct IntervalType
100  {
103  boolean min_inclusive;
104  boolean max_inclusive;
106  };
107 
109  {
111  };
112 
114  {
118  };
119 
120  struct Parameter
121  {
122  string name;
123 #ifndef ORBIT2_IDL
125 #else
126  TypeCode type;
127 #endif
129  };
130 
131  typedef sequence<Parameter> ParameterList;
133  {
134  NVList properties;
135  };
137  {
141  };
142 
144  {
145  string device_type;
146  string manufacturer;
147  string model;
148  string version;
149  NVList properties;
150  };
151 
153  {
154  string id;
156  NVList properties;
158  };
159 
160  typedef sequence <ServiceProfile> ServiceProfileList;
162  {
163  string id;
164  string description;
166  };
167 
168  typedef sequence<ConfigurationSet> ConfigurationSetList;
169 
170 
172  exception NotAvailable exception_body;
173  exception InterfaceNotImplemented exception_body;
174  exception InvalidParameter exception_body;
175  exception InternalError exception_body;
176 
179  {
180  OrganizationList get_owned_organizations()
181  raises (NotAvailable,InternalError);
182  };
183  interface SDO : SDOSystemElement
184  {
185  UniqueIdentifier get_sdo_id()
186  raises (NotAvailable, InternalError);
187  string get_sdo_type()
188  raises (NotAvailable, InternalError);
189  DeviceProfile get_device_profile ()
190  raises (NotAvailable, InternalError);
191  ServiceProfileList get_service_profiles ()
192  raises (NotAvailable, InternalError);
193  ServiceProfile get_service_profile (in UniqueIdentifier id)
194  raises (InvalidParameter, NotAvailable, InternalError);
195  SDOService get_sdo_service (in UniqueIdentifier id)
196  raises (InvalidParameter, NotAvailable, InternalError);
197  Configuration get_configuration ()
198  raises (InterfaceNotImplemented, NotAvailable, InternalError);
199  Monitoring get_monitoring ()
200  raises (InterfaceNotImplemented, NotAvailable, InternalError);
201  OrganizationList get_organizations ()
202  raises (NotAvailable, InternalError);
203  NVList get_status_list ()
204  raises (NotAvailable, InternalError);
205  any get_status (in string nme)
206  raises (InvalidParameter, NotAvailable, InternalError);
207  };
208 
209 
210  interface Configuration
211  {
212  boolean set_device_profile (in DeviceProfile dProfile)
213  raises (InvalidParameter, NotAvailable, InternalError);
214  boolean add_service_profile (in ServiceProfile sProfile)
215  raises (InvalidParameter, NotAvailable, InternalError);
216  boolean add_organization (in Organization organization_object)
217  raises (InvalidParameter, NotAvailable, InternalError);
218  boolean remove_service_profile (in UniqueIdentifier id)
219  raises (InvalidParameter, NotAvailable, InternalError);
220  boolean remove_organization (in UniqueIdentifier organization_id)
221  raises (InvalidParameter, NotAvailable, InternalError);
222  ParameterList get_configuration_parameters ()
223  raises (NotAvailable, InternalError);
224  NVList get_configuration_parameter_values ()
225  raises (NotAvailable, InternalError);
226  any get_configuration_parameter_value (in string name)
227  raises (InvalidParameter, NotAvailable, InternalError);
228  boolean set_configuration_parameter (in string name,
229  in any value)
230  raises (InvalidParameter, NotAvailable, InternalError);
231  ConfigurationSetList get_configuration_sets ()
232  raises (NotAvailable, InternalError);
233  ConfigurationSet get_configuration_set (in UniqueIdentifier config_id)
234  raises (NotAvailable, InternalError);
235  boolean set_configuration_set_values (in ConfigurationSet configuration_set)
236  raises (InvalidParameter, NotAvailable, InternalError);
237  ConfigurationSet get_active_configuration_set ()
238  raises (NotAvailable, InternalError);
239  boolean add_configuration_set (in ConfigurationSet configuration_set)
240  raises (InvalidParameter, NotAvailable, InternalError);
241  boolean remove_configuration_set (in UniqueIdentifier config_id)
242  raises (InvalidParameter, NotAvailable, InternalError);
243  boolean activate_configuration_set (in UniqueIdentifier config_id)
244  raises (InvalidParameter, NotAvailable, InternalError);
245  };
246 
247 
248 #ifdef USE_MONITORING
249  interface Monitoring : CosNotifyComm::StructuredPushConsumer,
250  CosNotifyComm::StructuredPushSupplier
251  {
252  any get_monitoring_parameter_value (in string name)
253  raises (InvalidParameter, NotAvailable, InternalError);
254  ParameterList get_monitoring_parameters ()
255  raises (NotAvailable, InternalError);
256  NVList get_monitoring_parameter_values ()
257  raises (NotAvailable, InternalError);
258  };
259 #else
260  interface Monitoring {};
261 #endif
262 
263  interface SDOService {};
264 
265  interface Organization
266  {
267  UniqueIdentifier get_organization_id ()
268  raises (InvalidParameter, NotAvailable, InternalError);
269  OrganizationProperty get_organization_property ()
270  raises (NotAvailable, InternalError);
271  any get_organization_property_value (in string name)
272  raises (InvalidParameter, NotAvailable, InternalError);
273  boolean add_organization_property (in OrganizationProperty organization_property)
274  raises (InvalidParameter, NotAvailable, InternalError);
275  boolean set_organization_property_value (in string name,
276  in any value)
277  raises (InvalidParameter, NotAvailable, InternalError);
278  boolean remove_organization_property ( in string name )
279  raises (InvalidParameter, NotAvailable, InternalError);
280  SDOSystemElement get_owner ()
281  raises (NotAvailable, InternalError);
282  boolean set_owner (in SDOSystemElement sdo)
283  raises (InvalidParameter, NotAvailable, InternalError);
284  SDOList get_members ()
285  raises (NotAvailable, InternalError);
286  boolean set_members (in SDOList sdos)
287  raises (InvalidParameter, NotAvailable, InternalError);
288  boolean add_members ( in SDOList sdo_list)
289  raises (InvalidParameter, NotAvailable, InternalError);
290  boolean remove_member (in UniqueIdentifier id)
291  raises (InvalidParameter, NotAvailable, InternalError);
292  DependencyType get_dependency()
293  raises (NotAvailable, InternalError);
294  boolean set_dependency (in DependencyType dependency)
295  raises (NotAvailable, InternalError);
296  };
297 };
298 #endif //_SDO_PACKAGE_IDL_
Definition: SDOPackage.idl:132
string UniqueIdentifier
Definition: SDOPackage.idl:60
sequence< Organization > OrganizationList
Definition: SDOPackage.idl:59
RangeType allowed_range
Definition: SDOPackage.idl:117
Numeric max
Definition: SDOPackage.idl:94
Definition: SDOPackage.idl:210
Definition: SDOPackage.idl:263
string name
Definition: SDOPackage.idl:122
sequence< ConfigurationSet > ConfigurationSetList
Definition: SDOPackage.idl:168
long long_value
Definition: SDOPackage.idl:81
float float_value
Definition: SDOPackage.idl:82
DependencyType
Definition: SDOPackage.idl:136
TypeCode type
Definition: SDOPackage.idl:124
string device_type
Definition: SDOPackage.idl:145
Definition: SDOPackage.idl:62
NVList properties
Definition: SDOPackage.idl:149
string name
Definition: SDOPackage.idl:64
Definition: SDOPackage.idl:110
EnumerationType allowed_enum
Definition: SDOPackage.idl:115
Definition: SDOPackage.idl:74
sequence< SDO > SDOList
Definition: SDOPackage.idl:58
Definition: SDOPackage.idl:143
sequence< NameValue > NVList
Definition: SDOPackage.idl:68
Definition: SDOPackage.idl:72
boolean max_inclusive
Definition: SDOPackage.idl:96
Definition: SDOPackage.idl:183
string version
Definition: SDOPackage.idl:148
StringList enumerated_values
Definition: SDOPackage.idl:88
boolean min_inclusive
Definition: SDOPackage.idl:103
Numeric min
Definition: SDOPackage.idl:93
NumericType
Definition: SDOPackage.idl:70
Definition: SDOPackage.idl:161
Definition: SDOPackage.idl:265
ComplexDataType
Definition: SDOPackage.idl:108
Definition: SDOPackage.idl:91
#define exception_body
Definition: SDOPackage.idl:45
Numeric min
Definition: SDOPackage.idl:101
Definition: SDOPackage.idl:86
IntervalType allowed_interval
Definition: SDOPackage.idl:116
Definition: SDOPackage.idl:110
string manufacturer
Definition: SDOPackage.idl:146
double double_value
Definition: SDOPackage.idl:83
Definition: SDOPackage.idl:140
boolean max_inclusive
Definition: SDOPackage.idl:104
string interface_type
Definition: SDOPackage.idl:155
NVList properties
Definition: SDOPackage.idl:134
Definition: SDOPackage.idl:110
sequence< string > StringList
Definition: SDOPackage.idl:54
any value
Definition: SDOPackage.idl:65
Definition: SDOPackage.idl:73
SDOService service
Definition: SDOPackage.idl:157
NVList configuration_data
Definition: SDOPackage.idl:165
Definition: SDOPackage.idl:99
string id
Definition: SDOPackage.idl:163
Definition: SDOPackage.idl:178
sequence< ServiceProfile > ServiceProfileList
Definition: SDOPackage.idl:160
Numeric step
Definition: SDOPackage.idl:105
#define TypeCode
Definition: SDOPackage.idl:40
Definition: SDOPackage.idl:260
string id
Definition: SDOPackage.idl:154
string model
Definition: SDOPackage.idl:147
sequence< Parameter > ParameterList
Definition: SDOPackage.idl:131
string description
Definition: SDOPackage.idl:164
Definition: SDOPackage.idl:152
Definition: SDOPackage.idl:75
boolean min_inclusive
Definition: SDOPackage.idl:95
AllowedValues allowed_values
Definition: SDOPackage.idl:128
Definition: SDOPackage.idl:139
Numeric max
Definition: SDOPackage.idl:102
Definition: SDOPackage.idl:138
Definition: SDOPackage.idl:113
Definition: SDOPackage.idl:78
Definition: SDOPackage.idl:120
NVList properties
Definition: SDOPackage.idl:156
short short_value
Definition: SDOPackage.idl:80