device.idl

Go to the documentation of this file.
00001 // OSB library ************************************************ -*- C++ -*-
00006 /*
00007   AUTHOR(S): Stephan Broennimann (vb)
00008 
00009   RCS information
00010    $Name: OSB_060808 $
00011    $Revision: 1.9.2.1 $
00012 
00013   License
00014    OSB rating and billing library for communication networks
00015    Copyright (C) 2004, 2005, 2006  OSB systems
00016 
00017    This file may be distributed and/or modify under the terms of the
00018    GNU General Public License (GPL) as published by the Free Software
00019    Foundation which is provided in the file LICENSE.GPL included in the
00020    packaging of this file.
00021 
00022    The file is distributed in the hope that it will be useful, but WITHOUT
00023    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00024    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00025    for more details.
00026 
00027    Holders of a OSB Commercial License may use this file under the terms
00028    and conditions of this commercial license.
00029  */
00030 #ifndef _DEVICE_IDL_
00031 #define _DEVICE_IDL_
00032 
00033 // ************************************************************************
00034 // included idl files
00035 #include "corba_utility.idl"
00036 #include "inventorypool.idl"
00037 
00038 // ************************************************************************
00039 // module extensions
00040 module corba {
00041   module dvc {
00042 
00043 // ************************************************************************
00044 // forward declarations
00045     interface DeviceWriter;
00046 
00047 // ************************************************************************
00048 // type definitions
00050     struct DeviceType {
00052         long type;
00053     };                                  // struct DeviceTyped
00054 
00056     struct DeviceId {
00058         long id;
00059     };                                  // struct DeviceId
00060 
00062     enum DeviceStatus {
00064         dvcUnknown,
00066         dvcCreated,
00068         dvcAvailable,
00070         dvcAssigned,
00072         dvcDeactivated
00073     };
00074 
00076     typedef sequence<dvc::DeviceId> DeviceIds;
00077 
00078 // ************************************************************************
00079 // interface definitions
00080 
00087     interface Device {
00089         DeviceType type()
00090           raises (common::OsbCorbaException);
00091 
00093         DeviceId id()
00094           raises (common::OsbCorbaException);
00095 
00097         DeviceStatus status()
00098           raises (common::OsbCorbaException);
00099 
00106         imgmt::PoolId poolId()
00107           raises (common::OsbCorbaException);
00108 
00113         void destroy();
00114     };                                  // interface Device
00115 
00119     interface DeviceWriter : Device {
00129         void setPool(
00130             in imgmt::PoolId poolId
00131         ) raises (common::OsbCorbaException);
00142         void setStatus(
00143             in DeviceStatus newStatus
00144         ) raises (common::OsbCorbaException);
00145 
00157         void updData(
00158             in boolean noWait
00159         ) raises (common::OsbCorbaException);
00160 
00172         void updStatus(
00173             in boolean noWait
00174         ) raises (common::OsbCorbaException);
00175     };                                  // interface DeviceWriter
00176   };                                    // module dvc
00177 };                                      // module corba
00178 #endif                                  // #ifndef _DEVICE_IDL_

Generated on Sat Sep 2 14:23:00 2006 for OSB Library by  doxygen 1.4.7