/usr/include/tango/device_2.h is in libtango7-dev 7.2.6+dfsg-4build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 | //=============================================================================
//
// file : Device.h
//
// description : Include for the Device root classes.
// Three classes are declared in this file :
// The Device class
// The DeviceClass class
//
// project : TANGO
//
// author(s) : A.Gotz + E.Taurel
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2010,2011
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// This file is part of Tango.
//
// Tango is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Tango is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Tango. If not, see <http://www.gnu.org/licenses/>.
//
// $Revision: 15556 $
//
// $Log$
// Revision 3.12 2010/09/09 13:45:22 taurel
// - Add year 2010 in Copyright notice
//
// Revision 3.11 2009/01/21 12:49:04 taurel
// - Change CopyRights for 2009
//
// Revision 3.10 2009/01/19 08:06:26 taurel
// - Fix warnings generated by Doxygen
//
// Revision 3.9 2008/12/17 09:50:59 taurel
// - First implementation of attributes sent on the wire using IDL Union
// instead of IDL Any
//
// Revision 3.8 2008/10/06 15:00:36 taurel
// - Changed the licensing info from GPL to LGPL
//
// Revision 3.7 2008/10/03 06:51:36 taurel
// - Add some licensing info in each files
//
// Revision 3.6 2008/09/23 14:59:33 taurel
// - Commit after the end of DevEncoded data type implementation
// - The new test suite is also now running fine
//
// Revision 3.5 2008/06/10 07:52:14 taurel
// - Add code for the DevEncoded attribute data type
//
// Revision 3.4 2005/01/14 12:29:20 taurel
// - Fix bug in getting attribute history for client linked with V4 and getting the
// history for attribute belonging to a Device_3Impl device
//
// Revision 3.3 2005/01/13 08:29:05 taurel
// - Merge trunk with Release_5_0 from brach Release_5_branch
//
// Revision 3.2.2.1 2004/09/15 06:45:45 taurel
// - Added four new types for attributes (boolean, float, unsigned short and unsigned char)
// - It is also possible to read state and status as attributes
// - Fix bug in Database::get_class_property() method (missing ends insertion)
// - Fix bug in admin device DevRestart command (device name case problem)
//
// Revision 3.2 2004/07/07 08:40:11 taurel
//
// - Fisrt commit after merge between Trunk and release 4 branch
// - Add EventData copy ctor, asiignement operator and dtor
// - Add Database and DeviceProxy::get_alias() method
// - Add AttributeProxy ctor from "device_alias/attribute_name"
// - Exception thrown when subscribing two times for exactly yhe same event
//
// Revision 3.1 2003/08/21 07:23:46 taurel
// - End of the implementation of the new way to transfer data for read and
// write attributes (better use of exception)
// - Added Attribute::set_date() and Attribute::set_value_date_quality() methods
// - Added DeviceAttribute ctors from "const char *"
// - Enable writing of spectrum and image attributes
// - Many new DeviceAttribute ctors/inserters to enable easy image and spectrums
// attribute writing
// - Attribute date automatically set in case of attribute quality factor set to INVALID
// - Change in the polling thread discarding element algo. to support case of polling
// several cmd/atts at the same polling period with cmd/attr having a long response time
// - Take cmd/attr execution time into account in the "Data not updated since" polling
// status string
// - Split "str().c_str()" code in two lines of code. It was the reason of some problem
// on Windows device server
// - Add the possibility to set a cmd/attr polling as "externally triggered". Add method
// to send trigger to the polling thread
//
// Revision 3.0.4.1 2004/03/09 16:36:36 taurel
// - Added HP aCC port (thanks to Claudio from Elettra)
// - Some last small bugs fixes
//
// Revision 3.0 2003/03/25 16:41:53 taurel
// Many changes for Tango release 3.0 including
// - Added full logging features
// - Added asynchronous calls
// - Host name of clients now stored in black-box
// - Three serialization model in DS
// - Fix miscellaneous bugs
// - Ported to gcc 3.2
// - Added ApiUtil::cleanup() and destructor methods
// - Some internal cleanups
// - Change the way how TangoMonitor class is implemented. It's a recursive
// mutex
//
// Revision 2.8 2002/12/16 12:06:22 taurel
// No change in code at all but only forgot th emost important line in
// list of updates in the previous release :
// - Change underlying ORB from ORBacus to omniORB
//
// Revision 2.7 2002/12/16 10:16:21 taurel
// - New method get_device_list() in Util class
// - Util::get_class_list takes DServer device into account
// - Util::get_device_by_name() takes DServer device into account
// - Util::get_device_list_by_class() takes DServer device into account
// - New parameter to the attribute::set_value() method to enable CORBA to free
// memory allocated for the attribute
//
// Revision 2.6 2002/10/17 07:43:06 taurel
// Fix bug in history stored by the polling thread :
// - We need one copy of the attribute data to build an history!!! It is true
// also for command which return data created by the DeviceImpl::create_xxx
// methods. Chnage in pollring.cpp/pollring.h/dserverpoll.cpp/pollobj.cpp
// and pollobj.h
//
// Revision 2.5 2002/10/15 11:27:19 taurel
// Fix bugs in device.cpp file :
// - Protect the state and status CORBA attribute with the device monitor
// Add the "TgLibVers" string as a #define in tango_config.h
//
// Revision 2.4 2002/08/12 15:06:54 taurel
// Several big fixes and changes
// - Remove HP-UX specific code
// - Fix bug in polling alogorithm which cause the thread to enter an infinite
// loop (pollthread.cpp)
// - For bug for Win32 device when trying to set attribute config
// (attribute.cpp)
//
// Revision 2.3 2002/07/02 15:22:24 taurel
// Miscellaneous small changes/bug fixes for Tango CPP release 2.1.0
// - classes reference documentation now generated using doxygen instead of doc++
// - A little file added to the library which summarizes version number.
// The RCS/CVS "ident" command will now tells you that release library x.y.z is composed
// by C++ client classes set release a.b and C++ server classes set release c.d
// - Fix incorrect field setting for DevFailed exception re-thrown from a CORBA exception
// - It's now not possible to poll the Init command
// - It's now possible to define a default class doc. per control system
// instance (using property)
// - The test done to check if attribute value has been set before it is
// returned to caller is done only if the attribute quality is set to VALID
// - The JTCInitialize object is now stored in the Util
// - Windows specific : The tango.h file now also include winsock.h
//
// Revision 2.2 2002/04/30 10:50:41 taurel
// Don't check alarm on attribute if attribute quality factor is INVALID
//
// Revision 2.1 2002/04/29 12:24:03 taurel
// Fix bug in attribute::set_value method and on the check against min and max value when writing attributes
//
// Revision 2.0 2002/04/09 14:45:09 taurel
// See Tango WEB pages for list of changes
//
// Revision 1.6 2001/10/08 09:03:12 taurel
// See tango WEB pages for list of changes
//
// Revision 1.5 2001/07/04 12:27:10 taurel
// New methods re_throw_exception(). Read_attributes supports AllAttr mnemonic A new add_attribute()method in DeviceImpl class New way to define attribute properties New pattern to prevent full re-compile For multi-classes DS, it is now possible to use the Util::get_device_by_name() method in device constructor Adding << operator ovebloading Fix devie CORBA ref. number when device constructor sends an excep.
//
// Revision 1.4 2001/05/04 09:28:13 taurel
// Fix bugs in DServer::restart() method and in Util::get_device_by_name() method
//
// Revision 1.3 2001/03/30 08:03:45 taurel
// Fix bugs in attributes. For linux, add signal_handler in its own thread, change the way to kill server. For all system, change DevRestart philosophy.
//
// Revision 1.2 2001/03/09 08:20:15 taurel
// Fix bug in the MultiClassAttribute::init_class_attribute() method. Also remove the DbErr_DeviceNotDefined define.
//
// Revision 1.1.1.1 2001/02/27 08:46:20 taurel
// Imported sources
//
// Revision 1.3 2000/04/13 10:40:40 taurel
// Added attribute support
//
// Revision 1.2 2000/02/04 11:00:14 taurel
// Just update revision number
//
// Revision 1.1.1.1 2000/02/04 10:58:28 taurel
// Imported sources
//
//=============================================================================
#ifndef _DEVICE_2_H
#define _DEVICE_2_H
#include <tango.h>
namespace Tango
{
class DeviceClass;
//=============================================================================
//
// The Device_2Impl class
//
//
// description : This class is derived directly from the Tango::Device_skel
// class generated by CORBA. It represents the CORBA
// servant which will be accessed by the client.
// It implements all the methods
// and attributes defined in the IDL interface for Device.
//
//=============================================================================
class Device_2ImplExt
{
};
/**
* Base class for all TANGO device since version 2.
*
* This class inherits from DeviceImpl class which itself inherits from
* CORBA classes where all the network layer is implemented.
* This class has been created since release 2 of Tango library where the IDL
* Tango module has been modified in order to create a Device_2 interface
* which inherits from the original Device interface
*
* $Author: taurel $
* $Revision: 15556 $
*/
class Device_2Impl : public virtual POA_Tango::Device_2,
public DeviceImpl
{
public:
/**@name Constructors
* Miscellaneous constructors */
//@{
/**
* Constructs a newly allocated Device_2Impl object from its name.
*
* The device description field is set to <i>A Tango device</i>. The device
* state is set to unknown and the device status is set to
* <b>Not Initialised</b>
*
* @param device_class Pointer to the device class object
* @param dev_name The device name
*
*/
Device_2Impl(DeviceClass *device_class,string &dev_name);
/**
* Constructs a newly allocated Device_2Impl object from its name and its description.
*
* The device
* state is set to unknown and the device status is set to
* <i>Not Initialised</i>
*
* @param device_class Pointer to the device class object
* @param dev_name The device name
* @param desc The device description
*
*/
Device_2Impl(DeviceClass *device_class,string &dev_name,string &desc);
/**
* Constructs a newly allocated Device_2Impl object from all its creation
* parameters.
*
* The device is constructed from its name, its description, an original state
* and status
*
* @param device_class Pointer to the device class object
* @param dev_name The device name
* @param desc The device description
* @param dev_state The device initial state
* @param dev_status The device initial status
*
*/
Device_2Impl(DeviceClass *device_class,
string &dev_name,string &desc,
Tango::DevState dev_state,string &dev_status);
/**
* Constructs a newly allocated Device_2Impl object from all its creation
* parameters with some default values.
*
* The device is constructed from its name, its description, an original state
* and status. This constructor defined default values for the description,
* state and status parameters. The default device description is <i>A TANGO device</i>.
* The default device state is <i>UNKNOWN</i> and the default device status
* is <i>Not initialised</i>.
*
* @param device_class Pointer to the device class object
* @param dev_name The device name
* @param desc The device desc
* @param dev_state The device initial state
* @param dev_status The device initial status
*
*/
Device_2Impl(DeviceClass *device_class,
const char *dev_name,const char *desc = "A TANGO device",
Tango::DevState dev_state = Tango::UNKNOWN,
const char *dev_status = StatusNotSet);
//@}
/**@name Destructor
* Only one desctructor is defined for this class */
//@{
/**
* The device desctructor.
*/
virtual ~Device_2Impl() {delete ext_2;}
//@}
/**@name CORBA operation methods
* Method defined to implement TANGO device CORBA operation */
//@{
/**
* Execute a command.
*
* It's the master method executed when a "command_inout_2" CORBA operation is
* requested by a client. It updates the device black-box, call the
* TANGO command handler and returned the output Any
*
* @param in_cmd The command name
* @param in_data The command input data packed in a CORBA Any
* @param source The data source. This parameter is new in Tango release 2. It
* allows a client to choose the data source between the device itself or the
* data cache for polled command.
* @return The command output data packed in a CORBA Any object
* @exception DevFailed Re-throw of the exception thrown by the command_handler
* method.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
virtual CORBA::Any *command_inout_2(const char *in_cmd,
const CORBA::Any &in_data,
Tango::DevSource source)
throw (Tango::DevFailed, CORBA::SystemException);
/**
* Get device command list.
*
* Invoked when the client request the command_list_query_2 CORBA operation.
* It updates the device black box and returns an array of DevCmdInfo_2 object
* with one object for each command.
*
* @return The device command list. One DevCmdInfo_2 is initialised for each
* device command. Since Tango release 2, the command display level field has
* been added to this structure
*/
virtual Tango::DevCmdInfoList_2 *command_list_query_2()
throw (Tango::DevFailed, CORBA::SystemException);
/**
* Get command info.
*
* Invoked when the client request the command_query_2 CORBA operation.
* It updates the device black box and returns a DevCmdInfo_2 object for the
* command with name passed
* to the method as parameter.
*
* @param command The command name
* @return A DevCmdInfo_2 initialised for the wanted command.
* @exception DevFailed Thrown if the command does not exist.
* Since Tango release 2, the command display level field has
* been added to this structure.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
virtual Tango::DevCmdInfo_2 *command_query_2(const char *command)
throw (Tango::DevFailed, CORBA::SystemException);
/**
* Read attribute(s) value.
*
* Invoked when the client request the read_attributes_2 CORBA operation.
* It returns to the client one AttributeValue structure for each wanted
* attribute.
*
* @param names The attribute(s) name list
* @param source The data source. This parameter is new in Tango release 2. It
* allows a client to choose the data source between the device itself or the
* data cache for polled attribute.
* @return A sequence of AttributeValue structure. One structure is initialised
* for each wanted attribute with the attribute value, the date and the attribute
* value quality. Click <a href="../../../tango_idl/idl_html/_Tango.html#AttributeValue">here</a>
* to read <b>AttributeValue</b> structure definition.
* @exception DevFailed Thrown if the attribute does not exist.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
virtual Tango::AttributeValueList *read_attributes_2(const Tango::DevVarStringArray& names,
Tango::DevSource source)
throw (Tango::DevFailed, CORBA::SystemException);
/**
* Get attribute(s) configuration.
*
* Invoked when the client request the get_attribute_config_2 CORBA operation.
* It returns to the client one AttributeConfig_2 structure for each wanted
* attribute. All the attribute properties value are returned in this
* AttributeConfig_2 structure. Since Tango release 2, the attribute display
* level field has been added to this structure.
*
* @param names The attribute(s) name list
* @return A sequence of AttributeConfig_2 structure. One structure is initialised
* for each wanted attribute. Click <a href="../../../tango_idl/idl_html/_Tango.html#AttributeConfig_2">here</a>
* to read <b>AttributeConfig_2</b> structure specification.
*
* @exception DevFailed Thrown if the attribute does not exist.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
virtual Tango::AttributeConfigList_2 *get_attribute_config_2(const Tango::DevVarStringArray& names)
throw(Tango::DevFailed, CORBA::SystemException);
/**
* Read attribute value history.
*
* Invoked when the client request the read_attribute_history_2 CORBA operation.
* This operation allows a client to retrieve attribute value history for
* polled attribute. The depth of the history is limited to the depth of
* the device server internal polling buffer.
* It returns to the client one DevAttrHistory structure for each record.
*
* @param name The attribute name
* @param n The record number.
* @return A sequence of DevAttrHistory structure. One structure is initialised
* for each record with the attribute value, the date and in case of the attribute
* returns an error when it was read, the DevErrors data.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevAttrHistory">here</a>
* to read <b>DevAttrHistory</b> structure definition.
* @exception DevFailed Thrown if the attribute does not exist or is not polled.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
virtual Tango::DevAttrHistoryList *read_attribute_history_2(const char* name,
CORBA::Long n)
throw(Tango::DevFailed, CORBA::SystemException);
/**
* Read command value history.
*
* Invoked when the client request the command_inout_history_2 CORBA operation.
* This operation allows a client to retrieve command return value history for
* polled command. The depth of the history is limited to the depth of
* the device server internal polling buffer.
* It returns to the client one DevCmdHistory structure for each record.
*
* @param command The command name
* @param n The record number.
* @return A sequence of DevCmdHistory structure. One structure is initialised
* for each record with the command return value (in an Any), the date
* and in case of the command returns an error when it was read, the
* DevErrors data.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevCmdHistory">here</a>
* to read <b>DevCmdHistory</b> structure definition.
* @exception DevFailed Thrown if the attribute does not exist or is not polled.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
virtual Tango::DevCmdHistoryList *command_inout_history_2(const char* command,
CORBA::Long n)
throw(Tango::DevFailed, CORBA::SystemException);
//@}
private:
CORBA::Any *attr2cmd(AttributeValue_3 &,bool,bool);
CORBA::Any *attr2cmd(AttributeValue_4 &,bool,bool);
void Hist_32Hist(DevAttrHistoryList_3 *,DevAttrHistoryList *);
void Polled_2_Live(long,Tango::AttrValUnion &,CORBA::Any &);
void Polled_2_Live(long,CORBA::Any &,CORBA::Any &);
Device_2ImplExt *ext_2;
};
} // End of Tango namespace
#endif // _DEVICE_H
|