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