lib/cpp/server/deviceclass.h

   1 //=============================================================================
   2 //
   3 // file :               Deviceclass.h
   4 //
   5 // description :        Include file for the DeviceClass root class.
   6 //
   7 // project :            TANGO
   8 //
   9 // author(s) :          E.Taurel
  10 //
  11 // Copyright (C) :      2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015
  12 //                                              European Synchrotron Radiation Facility
  13 //                      BP 220, Grenoble 38043
  14 //                      FRANCE
  15 //
  16 // This file is part of Tango.
  17 //
  18 // Tango is free software: you can redistribute it and/or modify
  19 // it under the terms of the GNU Lesser General Public License as published by
  20 // the Free Software Foundation, either version 3 of the License, or
  21 // (at your option) any later version.
  22 //
  23 // Tango is distributed in the hope that it will be useful,
  24 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  25 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26 // GNU Lesser General Public License for more details.
  27 //
  28 // You should have received a copy of the GNU Lesser General Public License
  29 // along with Tango.  If not, see <http://www.gnu.org/licenses/>.
  30 //
  31 // $Revision: 28932 $
  32 //
  33 //
  34 //=============================================================================
  35
  36 #ifndef _DEVICECLASS_H
  37 #define _DEVICECLASS_H
  38
  39 namespace Tango
  40 {
  41
  42 class Command;
  43 class Pipe;
  44 class DeviceClass;
  45 class AutoTangoMonitor;
  46 class NoSyncModelTangoMonitor;
  47 class EventSupplier;
  48 class Util;
  49 class DServer;
  50
  51
  52 //=============================================================================
  53 //
  54 //                      The DeviceClass class
  55 //
  56 //
  57 // description :        This class will act as root class for all other
  58 //                      DeviceClass classes. Its job is to define all Device
  59 //                      class related properties and methods which exist only
  60 //                      once e.g. the command list.
  61 //
  62 //=============================================================================
  63
  64 /**
  65  * Base class for all TANGO device-class class. A TANGO device-class class is
  66  * a class where is stored all data/method common to all devices of a TANGO
  67  * device class
  68  *
  69  * $Author: taurel $
  70  * $Revision: 28932 $
  71  *
  72  * @headerfile tango.h
  73  * @ingroup Server
  74  */
  75
  76 class
  77 #ifdef _TG_WINDOWS_
  78         #ifndef _TANGO_LIB
  79                 __declspec(dllexport)
  80         #endif
  81 #endif
  82                 DeviceClass
  83 {
  84         friend class Tango::AutoTangoMonitor;
  85 public:
  86
  87 /**@name Destructor
  88  * Only one desctructor is defined for this class */
  89 //@{
  90 /**
  91  * The device destructor.
  92  */
  93         virtual ~DeviceClass();
  94 //@}
  95
  96 /**@name Miscellaneous methods */
  97 //@{
  98 /**
  99  * Execute a command.
 100  *
 101  * It looks for the correct command object in the command object vector.
 102  * If the command is found, it invoke the <i>always_executed_hook</i> method.
 103  * Check if the command is allowed by invoking the <i>is_allowed</i> method
 104  * If the command is allowed, invokes the <i>execute</i> method.
 105  *
 106  * @param       device  The device on which the command must be executed
 107  * @param       command The command name
 108  * @param       in_any  The command input data still packed in a CORBA Any object
 109  * @return      A CORBA Any object with the output data packed in
 110  * @exception DevFailed If the command is not found, if the command is not allowed
 111  * in the actual device state and re-throws of all the exception thrown by the
 112  * <i>always_executed_hook</i>, <i>is_alloed</i> and <i>execute</i> methods.
 113  * Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
 114  * <b>DevFailed</b> exception specification
 115  *
 116  */
 117         CORBA::Any *command_handler(DeviceImpl *device,
 118                                     string &command,const CORBA::Any &in_any);
 119 /**
 120  * Create command objects for all command supported by this class of device.
 121  *
 122  * In the DeviceClass class, this method is pure abstract and must be defined
 123  * in sub-class. Its rule is to create the command object and to store them
 124  * in a vector of command objects
 125  *
 126  */
 127         virtual void command_factory() = 0;
 128 /**
 129  * Create all the attributes name supported by this class of device.
 130  *
 131  * In the DeviceClass class, this method does nothing and must be re-defined
 132  * in sub-class if the sub-class supports attributes. Its rule is to
 133  * create and store the supported attributes in a vector.
 134  *
 135  */
 136         virtual void attribute_factory(vector<Attr *> &) {};
 137 /**
 138  * Create all the pipes supported by this class of device.
 139  *
 140  * In the DeviceClass class, this method does nothing and must be re-defined
 141  * in sub-class if the sub-class supports pipes. Its rule is to
 142  * create and store the supported pipes in a vector.
 143  *
 144  */
 145         virtual void pipe_factory() {};
 146
 147 /**
 148  * Create device(s).
 149  *
 150  * In the DeviceClass class, this method is pure abstract and must be defined
 151  * in sub-class. Its rule is to create all the class devices and to store them
 152  * in a vector of device
 153  *
 154  * @param dev_list The device name list
 155  * @exception DevFailed This method does not throw exception but a
 156  * redefined method can.
 157  * Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
 158  * <b>DevFailed</b> exception specification
 159  */
 160         virtual void device_factory(const Tango::DevVarStringArray *dev_list) = 0;
 161
 162 /**
 163  * Create device(s) name list (for no database device server).
 164  *
 165  * This method can be re-defined in DeviceClass sub-class for device server
 166  * started without database. Its rule is to initialise class device name.
 167  * The default method does nothing.
 168  *
 169  * @param list Reference to the device name list
 170  */
 171
 172         virtual void device_name_factory(vector<string> &list) {(void)list;};
 173
 174 /**
 175  * Delete device.
 176  *
 177  * The rule of this method is to delete a device from the running
 178  * server belonging to the Tango class. It does change anything in the
 179  * database
 180  *
 181  * @param dev_name Reference to the device name
 182  */
 183
 184         void device_destroyer(const string &dev_name);
 185
 186 /**
 187  * Delete device.
 188  *
 189  * The rule of this method is to delete a device from the running
 190  * device belonging to the Tango class. It does change anything in the
 191  * database
 192  *
 193  * @param dev_name Reference to the device name
 194  */
 195
 196         void device_destroyer(const char *dev_name);
 197
 198 //@}
 199
 200 /**@name Get/Set object members.
 201  * These methods allows the external world to get/set DeviceImpl instance
 202  * data members
 203  */
 204 //@{
 205 /**
 206  * Get the TANGO device class name.
 207  *
 208  * @return The TANGO device class name
 209  */
 210         string &get_name() {return name;}
 211 /**
 212  * Get the TANGO device class documentation URL.
 213  *
 214  * @return The TANGO device class documentation
 215  */
 216         string &get_doc_url() {return doc_url;}
 217 /**
 218  * Get the TANGO device type name.
 219  *
 220  * @return The TANGO device type name
 221  */
 222         string &get_type() {return type;}
 223 /**
 224  * Get the device object vector.
 225  *
 226  * @return A reference to the device vector
 227  */
 228         vector<DeviceImpl *> &get_device_list() {return device_list;}
 229 /**
 230  * Get the command object vector.
 231  *
 232  * @return A reference to the command vector
 233  */
 234         vector<Command *> &get_command_list() {return command_list;}
 235 /**
 236  * Get the pipe object vector.
 237  *
 238  * @param dev_name The device name
 239  *
 240  * @return A reference to the pipe vector containing all device pipes
 241  */
 242         vector<Pipe *> &get_pipe_list(const string &dev_name);
 243 /**
 244  * Get a reference to a command object.
 245  *
 246  * @return A reference to the command object
 247  */
 248         Command &get_cmd_by_name(const string &);
 249 /**
 250  * Get a reference to a pipe object.
 251  *
 252  * @param pipe_name The pipe name
 253  * @param dev_name The device name
 254  *
 255  * @return A reference to the pipe object
 256  */
 257         Pipe &get_pipe_by_name(const string &pipe_name,const string &dev_name);
 258 /**
 259  * Get a pointer to the associated DbClass object.
 260  *
 261  * @return Pointer to the DbClas object
 262  */
 263
 264         DbClass *get_db_class() {return db_class;}
 265 /**
 266  * Get a pointer to the class attributes object
 267  *
 268  * @return A pointer to the instance of the MultiClassAttribute
 269  */
 270         MultiClassAttribute *get_class_attr() {return class_attr;}
 271 /**
 272  * Get a pointer to the class pipes object
 273  *
 274  * @return A pointer to the instance of the MultiClassPipe
 275  */
 276         MultiClassPipe *get_class_pipe() {return class_pipe;}
 277 /**
 278  * Set the TANGO device type name.
 279  *
 280  * @param dev_type The new TANGO device type name
 281  */
 282         void set_type(string &dev_type) {type = dev_type;}
 283 /**
 284  * Set the TANGO device type name.
 285  *
 286  * @param dev_type The new TANGO device type name
 287  */
 288         void set_type(const char *dev_type) {type = dev_type;}
 289 //@}
 290
 291
 292 /**@name Signal related methods
 293  * These methods allow a signal management at device level */
 294 //@{
 295 #if defined _TG_WINDOWS_
 296 /**
 297  * Register a signal.
 298  *
 299  * Register this class as class to be informed when signal signo is sent to
 300  * to the device server process
 301  *
 302  * @param signo The signal number
 303  * @exception DevFailed Thrown if the signal number is out of range or if the
 304  * operating system failed to register a signal for the process.
 305  * Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
 306  * <b>DevFailed</b> exception specification
 307  */
 308         void register_signal(long signo);
 309 #else
 310 /**
 311  * Register a signal.
 312  *
 313  * Register this class as class to be informed when signal signo is sent to
 314  * to the device server process. This method is available only under Linux.
 315  *
 316  * @param signo The signal number
 317  * @param own_handler A boolean set to true if you want the device signal handler
 318  * to be executed in its own handler instead of being executed by the signal
 319  * thread. If this parameter is set to true, care should be taken on how the
 320  * handler is written. A default false value is provided * @exception DevFailed Thrown if the signal number is out of range or if the
 321  * operating system failed to register a signal for the process.
 322  * Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
 323  * <b>DevFailed</b> exception specification
 324  */
 325         void register_signal(long signo,bool own_handler = false);
 326 #endif
 327
 328 /**
 329  * Unregister a signal.
 330  *
 331  * Unregister this class as class to be informed when signal signo is sent to
 332  * to the device server process
 333  *
 334  * @param signo The signal number
 335  * @exception DevFailed Thrown if the signal number is out of range or if the
 336  * operating system failed to unregister a signal for the process. Unregister
 337  * a device for a signal number for a device not previously registered is not
 338  * an error. This simply will do nothing.
 339  * Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
 340  * <b>DevFailed</b> exception specification
 341  */
 342         void unregister_signal(long signo);
 343
 344 /**
 345  * Signal handler.
 346  *
 347  * The method executed when the signal arrived in the device server process.
 348  * This method is defined as virtual and then, can be redefined following
 349  * device class needs.
 350  *
 351  * @param signo The signal number
 352  */
 353         virtual void signal_handler(long signo);
 354
 355 //@}
 356
 357 protected:
 358 /**@name Constructor
 359  Only one constructot for this class which is a singleton */
 360 //@{
 361 /**
 362  * Construct a newly allocated DeviceClass object.
 363  *
 364  * @param       s       The Tango device class name
 365  *
 366  */
 367         DeviceClass(string &s);
 368 //@}
 369
 370 /**@name Miscellaneous protected methods */
 371 //@{
 372 /**
 373  * Export a device.
 374  *
 375  * Associate the servant to a CORBA object and send device network parameter
 376  * to TANGO database. The main parameter sent to database is the CORBA
 377  * object stringified device IOR.
 378  *
 379  * @param dev The device to be exported (CORBA servant)
 380  * @param corba_dev_name The name to be used in the CORBA object key. This
 381  * parameter does not need to be set in most of cases and has a default value.
 382  * It is used for special device server like the database device server.
 383  * @exception DevFailed If the command sent to the database failed.
 384  * Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
 385  * <b>DevFailed</b> exception specification
 386  */
 387         void export_device(DeviceImpl *dev,const char* corba_dev_name = "Unused");
 388
 389 /**
 390  * Set a Tango classs default command
 391  *
 392  * Define one command to be the Tango class default command
 393  * The default command is the command which will be exceuted when
 394  * an unknown command is sent to one of the Tango class device
 395  * By default, there is no default class
 396  *
 397  * @param cmd The command object
 398  */
 399
 400         void set_default_command(Command *cmd) {default_cmd = cmd;}
 401 //@}
 402
 403 /**@name Class data members */
 404 //@{
 405 /**
 406  * The TANGO device class name
 407  */
 408         string                                  name;
 409 /**
 410  * The TANGO device class documentation URL
 411  */
 412         string                                  doc_url;
 413 /**
 414  * The TANGO device type name
 415  */
 416         string                                  type;
 417 /**
 418  * The command(s) list
 419  */
 420         vector<Command *>               command_list;
 421 /**
 422  * The device(s) list
 423  */
 424         vector<DeviceImpl *>    device_list;
 425 /**
 426  * The associated DbClass object
 427  */
 428         DbClass                                 *db_class;
 429 /**
 430  * Pointer to the class multi attribute object
 431  */
 432         MultiClassAttribute             *class_attr;
 433 /**
 434  * Pointer to the class multi pipe object
 435  */
 436         MultiClassPipe                  *class_pipe;
 437 /**
 438  * The pipe(s) list
 439  */
 440         vector<Pipe *>                  pipe_list;
 441 //@}
 442
 443 public:
 444 /// @privatesection
 445         vector<string> &get_nodb_name_list() {return nodb_name_list;}
 446         void set_memorized_values(bool flag, long idx = 0,bool from_init = false);
 447
 448         void add_wiz_dev_prop(string &name,string &desc,string &def);
 449         void add_wiz_dev_prop(string &name,string &desc);
 450
 451         void add_wiz_class_prop(string &name,string &desc,string &def);
 452         void add_wiz_class_prop(string &name,string &desc);
 453
 454         vector<string> &get_wiz_class_prop() {return wiz_class_prop;}
 455         vector<string> &get_wiz_dev_prop() {return wiz_dev_prop;}
 456
 457         string &get_cvs_tag() {return cvs_tag;}
 458         string &get_cvs_location() {return cvs_location;}
 459
 460         string &get_svn_tag() {return svn_tag;}
 461         string &get_svn_location() {return svn_location;}
 462
 463         void set_cvs_tag(string &str) {cvs_tag=str;}
 464         void set_cvs_location(string &str) {cvs_location=str;}
 465
 466         void add_device(DeviceImpl *dev) {device_list.push_back(dev);}
 467         void delete_dev(long idx,Tango::Util *tg,PortableServer::POA_ptr r_poa);
 468
 469         bool is_py_class() {return py_class;}
 470         void set_py_class(bool py) {py_class=py;}
 471         virtual void delete_class() {}
 472         void get_mcast_event(DServer *);
 473
 474         bool is_command_allowed(const char *);
 475
 476         bool get_device_factory_done() {return device_factory_done;}
 477         void set_device_factory_done(bool val) {device_factory_done = val;}
 478
 479         void check_att_conf();
 480         void release_devices_mon();
 481
 482         void remove_command(const string &);
 483
 484         void create_device_pipe(DeviceClass *,DeviceImpl *);
 485         vector<Pipe *> &get_pipe_list() {return pipe_list;}
 486
 487 protected:
 488 /// @privatesection
 489         Command *get_default_command() {return default_cmd;}
 490
 491 private:
 492     class DeviceClassExt
 493     {
 494     public:
 495         DeviceClassExt() {};
 496
 497         map<string,vector<Pipe *> > dev_pipe_list;
 498     };
 499
 500         void get_class_system_resource();
 501         void throw_mem_value(DeviceImpl *,Attribute &);
 502
 503         vector<string>                  wiz_class_prop;
 504         vector<string>                  wiz_dev_prop;
 505
 506         vector<string>                  allowed_cmds;
 507
 508 #ifdef HAS_UNIQUE_PTR
 509     unique_ptr<DeviceClassExt>      ext;           // Class extension
 510 #else
 511         DeviceClassExt                          *ext;
 512 #endif
 513
 514 //
 515 // Ported from the extension class
 516 //
 517
 518     vector<string>              nodb_name_list;
 519     TangoMonitor                only_one;
 520     string                              cvs_tag;
 521     string                              cvs_location;
 522     Command *                   default_cmd;
 523     bool                                py_class;
 524     string              svn_tag;
 525     string              svn_location;
 526     bool                device_factory_done;
 527 };
 528
 529
 530 } // End of Tango namespace
 531
 532 #endif // _DEVICECLASS_H