src/PseudoAxes/PseudoAxes.cpp

   1 static const char *RcsId = "$Header:  $";
   2 //+=============================================================================
   3 //
   4 // file :         PseudoAxes.cpp
   5 //
   6 // description :  C++ source for the PseudoAxes and its commands.
   7 //                The class is derived from Device. It represents the
   8 //                CORBA servant object which will be accessed from the
   9 //                network. All commands which can be executed on the
  10 //                PseudoAxes are implemented in this file.
  11 //
  12 // project :      TANGO Device Server
  13 //
  14 // $Author:  $
  15 //
  16 // $Revision:  $
  17 //
  18 // $Log:  $
  19 //
  20 // copyleft :     European Synchrotron Radiation Facility
  21 //                BP 220, Grenoble 38043
  22 //                FRANCE
  23 //
  24 //-=============================================================================
  25 //
  26 //              This file is generated by POGO
  27 //      (Program Obviously used to Generate tango Object)
  28 //
  29 //         (c) - Software Engineering Group - ESRF
  30 //=============================================================================
  31
  32
  33
  34 //===================================================================
  35 //
  36 //      The following table gives the correspondence
  37 //      between commands and method name.
  38 //
  39 //  Command name|  Method name
  40 //      ----------------------------------------
  41 //  State     |  dev_state()
  42 //  Status    |  dev_status()
  43 //  AxisInit  |  axis_init()
  44 //
  45 //===================================================================
  46
  47
  48 #include <tango.h>
  49 #include <PseudoAxes.h>
  50 #include <PseudoAxesClass.h>
  51
  52 #include "TangoHKLAdapterFactory.h"
  53
  54 namespace PseudoAxes_ns
  55 {
  56
  57 //+----------------------------------------------------------------------------
  58 //
  59 // method :             PseudoAxes::PseudoAxes(string &s)
  60 //
  61 // description :        constructor for simulated PseudoAxes
  62 //
  63 // in : - cl : Pointer to the DeviceClass object
  64 //      - s : Device name
  65 //
  66 //-----------------------------------------------------------------------------
  67 PseudoAxes::PseudoAxes(Tango::DeviceClass *cl,string &s)
  68 :Tango::Device_3Impl(cl,s.c_str())
  69 {
  70         init_device();
  71 }
  72
  73 PseudoAxes::PseudoAxes(Tango::DeviceClass *cl,const char *s)
  74 :Tango::Device_3Impl(cl,s)
  75 {
  76         init_device();
  77 }
  78
  79 PseudoAxes::PseudoAxes(Tango::DeviceClass *cl,const char *s,const char *d)
  80 :Tango::Device_3Impl(cl,s,d)
  81 {
  82         init_device();
  83 }
  84 //+----------------------------------------------------------------------------
  85 //
  86 // method :             PseudoAxes::delete_device()
  87 //
  88 // description :        will be called at device destruction or at init command.
  89 //
  90 //-----------------------------------------------------------------------------
  91 void PseudoAxes::delete_device()
  92 {
  93         //      Delete device's allocated object
  94
  95         if(_adapter){
  96                 _adapter->save();
  97                 _adapter->remove_dynamic_attributes();
  98                 _adapter = NULL;
  99         }
 100         _hklAdapter = NULL;
 101 }
 102
 103 //+----------------------------------------------------------------------------
 104 //
 105 // method :             PseudoAxes::init_device()
 106 //
 107 // description :        will be called at device initialization.
 108 //
 109 //-----------------------------------------------------------------------------
 110 void PseudoAxes::init_device()
 111 {
 112         INFO_STREAM << "PseudoAxes::PseudoAxes() create device " << device_name << endl;
 113
 114         // Initialise variables to default values
 115         //--------------------------------------------
 116         get_device_property();
 117
 118         _adapter = NULL;
 119         _hklAdapter = NULL;
 120
 121         // we can get the Diffractometer device adapter in the init as this one start all PseudoAxes
 122         if(!_hklAdapter)
 123                 _hklAdapter = Diffractometer_ns::TangoHKLAdapterFactory::instance()->get_diffractometer_adapter(diffractometerProxy);
 124
 125         if(_hklAdapter && !_adapter){
 126                 _adapter = _hklAdapter->pseudo_axes_adapter_get_by_name(engineName);
 127                 if(_adapter){
 128                         _adapter->set_device(this);
 129                         _adapter->add_dynamic_attributes();
 130                         _adapter->load();
 131                 }
 132         }
 133 }
 134
 135
 136 //+----------------------------------------------------------------------------
 137 //
 138 // method :             PseudoAxes::get_device_property()
 139 //
 140 // description :        Read the device properties from database.
 141 //
 142 //-----------------------------------------------------------------------------
 143 void PseudoAxes::get_device_property()
 144 {
 145         //      Initialize your default values here (if not done with  POGO).
 146         //------------------------------------------------------------------
 147
 148         //      Read device properties from database.(Automatic code generation)
 149         //------------------------------------------------------------------
 150         Tango::DbData   dev_prop;
 151         dev_prop.push_back(Tango::DbDatum("DiffractometerProxy"));
 152         dev_prop.push_back(Tango::DbDatum("EngineName"));
 153
 154         //      Call database and extract values
 155         //--------------------------------------------
 156         if (Tango::Util::instance()->_UseDb==true)
 157                 get_db_device()->get_property(dev_prop);
 158         Tango::DbDatum  def_prop, cl_prop;
 159         PseudoAxesClass *ds_class =
 160                 (static_cast<PseudoAxesClass *>(get_device_class()));
 161         int     i = -1;
 162
 163         //      Try to initialize DiffractometerProxy from class property
 164         cl_prop = ds_class->get_class_property(dev_prop[++i].name);
 165         if (cl_prop.is_empty()==false)  cl_prop  >>  diffractometerProxy;
 166         else {
 167                 //      Try to initialize DiffractometerProxy from default device value
 168                 def_prop = ds_class->get_default_device_property(dev_prop[i].name);
 169                 if (def_prop.is_empty()==false) def_prop  >>  diffractometerProxy;
 170         }
 171         //      And try to extract DiffractometerProxy value from database
 172         if (dev_prop[i].is_empty()==false)      dev_prop[i]  >>  diffractometerProxy;
 173
 174         //      Try to initialize EngineName from class property
 175         cl_prop = ds_class->get_class_property(dev_prop[++i].name);
 176         if (cl_prop.is_empty()==false)  cl_prop  >>  engineName;
 177         else {
 178                 //      Try to initialize EngineName from default device value
 179                 def_prop = ds_class->get_default_device_property(dev_prop[i].name);
 180                 if (def_prop.is_empty()==false) def_prop  >>  engineName;
 181         }
 182         //      And try to extract EngineName value from database
 183         if (dev_prop[i].is_empty()==false)      dev_prop[i]  >>  engineName;
 184
 185
 186
 187         //      End of Automatic code generation
 188         //------------------------------------------------------------------
 189
 190 }
 191 //+----------------------------------------------------------------------------
 192 //
 193 // method :             PseudoAxes::always_executed_hook()
 194 //
 195 // description :        method always executed before any command is executed
 196 //
 197 //-----------------------------------------------------------------------------
 198 void PseudoAxes::always_executed_hook()
 199 {
 200         if(!_hklAdapter)
 201                 _hklAdapter = Diffractometer_ns::TangoHKLAdapterFactory::instance()->get_diffractometer_adapter(diffractometerProxy);
 202
 203         if(_hklAdapter && !_adapter)
 204                 _adapter = _hklAdapter->pseudo_axes_adapter_get_by_name(engineName);
 205 }
 206
 207 //+----------------------------------------------------------------------------
 208 //
 209 // method :             PseudoAxes::read_attr_hardware
 210 //
 211 // description :        Hardware acquisition for attributes.
 212 //
 213 //-----------------------------------------------------------------------------
 214 void PseudoAxes::read_attr_hardware(vector<long> &attr_list)
 215 {
 216         DEBUG_STREAM << "PseudoAxes::read_attr_hardware(vector<long> &attr_list) entering... "<< endl;
 217         //      Add your own code here
 218         if(_hklAdapter)
 219                 _hklAdapter->update();
 220 }
 221 //+----------------------------------------------------------------------------
 222 //
 223 // method :             PseudoAxes::read_parameters
 224 //
 225 // description :        Extract real attribute values for parameters acquisition result.
 226 //
 227 //-----------------------------------------------------------------------------
 228 void PseudoAxes::read_parameters(Tango::Attribute &attr)
 229 {
 230         DEBUG_STREAM << "PseudoAxes::read_parameters(Tango::Attribute &attr) entering... "<< endl;
 231
 232         if(_adapter){
 233                 Matrix<double> const & img = _adapter->get_mode_parameters();
 234                 attr.set_value(img.data, img.xdim);
 235         }
 236 }
 237
 238 //+----------------------------------------------------------------------------
 239 //
 240 // method :             PseudoAxes::write_parameters
 241 //
 242 // description :        Write parameters attribute values to hardware.
 243 //
 244 //-----------------------------------------------------------------------------
 245 void PseudoAxes::write_parameters(Tango::WAttribute &attr)
 246 {
 247         DEBUG_STREAM << "PseudoAxes::write_parameters(Tango::WAttribute &attr) entering... "<< endl;
 248
 249         if(_adapter){
 250                 const Tango::DevDouble *values;
 251                 attr.get_write_value(values);
 252                 Matrix<double> img;
 253                 img.attach_to_const_buffer(values,
 254                                            attr.get_w_dim_x(), attr.get_w_dim_y());
 255
 256                 _adapter->set_mode_parameters(img);
 257         }
 258 }
 259
 260 //+----------------------------------------------------------------------------
 261 //
 262 // method :             PseudoAxes::read_pseudoAxisNames
 263 //
 264 // description :        Extract real attribute values for pseudoAxisNames acquisition result.
 265 //
 266 //-----------------------------------------------------------------------------
 267 void PseudoAxes::read_pseudoAxisNames(Tango::Attribute &attr)
 268 {
 269         DEBUG_STREAM << "PseudoAxes::read_pseudoAxisNames(Tango::Attribute &attr) entering... "<< endl;
 270         if(_adapter){
 271                 Matrix<char *> const & img = _adapter->get_pseudo_axis_names();
 272                 attr.set_value(img.data, img.xdim);
 273         }
 274 }
 275
 276
 277 //+----------------------------------------------------------------------------
 278 //
 279 // method :             PseudoAxes::read_mode
 280 //
 281 // description :        Extract real attribute values for mode acquisition result.
 282 //
 283 //-----------------------------------------------------------------------------
 284 void PseudoAxes::read_mode(Tango::Attribute &attr)
 285 {
 286         DEBUG_STREAM << "PseudoAxes::read_mode(Tango::Attribute &attr) entering... "<< endl;
 287         if(_adapter)
 288                 attr.set_value(_adapter->get_mode());
 289 }
 290
 291 //+----------------------------------------------------------------------------
 292 //
 293 // method :             PseudoAxes::write_mode
 294 //
 295 // description :        Write mode attribute values to hardware.
 296 //
 297 //-----------------------------------------------------------------------------
 298 void PseudoAxes::write_mode(Tango::WAttribute &attr)
 299 {
 300         DEBUG_STREAM << "PseudoAxes::write_mode(Tango::WAttribute &attr) entering... "<< endl;
 301         attr.get_write_value(attr_mode_write);
 302         if(_adapter)
 303                 _adapter->set_mode(attr_mode_write);
 304 }
 305
 306 //+----------------------------------------------------------------------------
 307 //
 308 // method :             PseudoAxes::read_modeNames
 309 //
 310 // description :        Extract real attribute values for modeNames acquisition result.
 311 //
 312 //-----------------------------------------------------------------------------
 313 void PseudoAxes::read_modeNames(Tango::Attribute &attr)
 314 {
 315         DEBUG_STREAM << "PseudoAxes::read_modeNames(Tango::Attribute &attr) entering... "<< endl;
 316         if(_adapter){
 317                 Matrix<char *> const & img = _adapter->get_mode_names();
 318                 attr.set_value(img.data, img.xdim);
 319         }
 320 }
 321
 322 //+----------------------------------------------------------------------------
 323 //
 324 // method :             PseudoAxes::read_parametersNames
 325 //
 326 // description :        Extract real attribute values for parametersNames acquisition result.
 327 //
 328 //-----------------------------------------------------------------------------
 329 void PseudoAxes::read_parametersNames(Tango::Attribute &attr)
 330 {
 331         DEBUG_STREAM << "PseudoAxes::read_parametersNames(Tango::Attribute &attr) entering... "<< endl;
 332         if(_adapter){
 333                 Matrix<char *> const & img = _adapter->get_mode_parameters_names();
 334                 attr.set_value(img.data, img.xdim);
 335         }
 336 }
 337
 338 //+------------------------------------------------------------------
 339 /**
 340  *      method: PseudoAxes::axis_init
 341  *
 342  *      description:    method to execute "AxisInit"
 343  *      Initialize the pseudoAxes (exemple the psi pseudo axis)
 344  *
 345  *
 346  */
 347 //+------------------------------------------------------------------
 348 void PseudoAxes::axis_init()
 349 {
 350         DEBUG_STREAM << "PseudoAxes::axis_init(): entering... !" << endl;
 351
 352         //      Add your own code to control device here
 353         if(_adapter)
 354                 _adapter->init();
 355 }
 356
 357
 358 //+------------------------------------------------------------------
 359 /**
 360  *      method: PseudoAxes::dev_state
 361  *
 362  *      description:    method to execute "State"
 363  *      This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.
 364  *
 365  * @return      State Code
 366  *
 367  */
 368 //+------------------------------------------------------------------
 369 Tango::DevState PseudoAxes::dev_state()
 370 {
 371         Tango::DevState argout = DeviceImpl::dev_state();
 372         DEBUG_STREAM << "PseudoAxes::dev_state(): entering... !" << endl;
 373
 374         //      Add your own code to control device here
 375
 376         if(_adapter)
 377                 argout = _adapter->get_state();
 378
 379         set_state(argout);
 380         return argout;
 381 }
 382
 383 //+------------------------------------------------------------------
 384 /**
 385  *      method: PseudoAxes::dev_status
 386  *
 387  *      description:    method to execute "Status"
 388  *      This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.
 389  *
 390  * @return      Status description
 391  *
 392  */
 393 //+------------------------------------------------------------------
 394 Tango::ConstDevString PseudoAxes::dev_status()
 395 {
 396         Tango::ConstDevString   argout = DeviceImpl::dev_status();
 397         DEBUG_STREAM << "PseudoAxes::dev_status(): entering... !" << endl;
 398
 399         //      Add your own code to control device here
 400
 401         if(_adapter)
 402                 argout = _adapter->get_status().c_str();
 403
 404         set_status(argout);
 405         return argout;
 406 }
 407
 408 }       //      namespace