#ifndef acsexmplLampImpl_h #define acsexmplLampImpl_h /******************************************************************************* * ALMA - Atacama Large Millimiter Array * (c) European Southern Observatory, 2002 * Copyright by ESO (in the framework of the ALMA collaboration) * and Cosylab 2002, All rights reserved * * This library 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 2.1 of the License, or (at your option) any later version. * * This library 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 this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * "@(#) $Id: acsexmplLampImpl.h,v 1.99 2008/10/01 04:30:47 cparedes Exp $" * * who when what * -------- -------- ---------------------------------------------- * acaproni 2004-04-06 Use smart pointers for properties * david 2002-07-02 added GNU license info * david 2002-06-16 Finished adding doxygen comments. * david 2002-06-13 Deleted typedefinition of Lamp::*ActionFunction as it is not used in this example. * david 2002-06-10 Added some doxygen comments to clean it up for documentation * gchiozzi 2002-01-28 cleaned up remaining "mount" strings and replaced with "acsexmpl" * gchiozzi 2001-02-15 Added declaration of get_interface() method for Object Explorer * gchiozzi 2001-02-15 created created standard header * msekoran 2001-03-10 integrated with new BACI; ALMA coding convention used; doc. */ #ifndef __cplusplus #error This is a C++ include file and cannot be used from plain C #endif #include #include #include ///Import the smart pointer for the property #include /** @file acsexmplLampImpl.h */ /** @addtogroup ACSEXMPLTOC */ /*@{ */ /** @addtogroup ACSEXMPLTOCCOMPONENTS */ /*@{ */ /** @defgroup ACSEXMPLLAMPDOC Lamp * @{ * @htmlonly

Description

The class Lamp is a very simple example of a component that simulates the behavior of a lamp.  
It has two asynchronous methods: on(...) and off(...).  It also has one read-write double property: brightness.

What can I gain from this example?

  • an example derived from the ACS::CharacteristicComponent IDL interface.
  • an understanding of simple asynchronous method implementation accomplished by inheriting methods from the ActionImplementator class.


Links

@endhtmlonly * @} */ /** * Simple component with asynchronous methods. * This class Lamp simulates the behavior of a lamp. * It provides two asynchronous methods: on and off. * It also provides the property brightness. * Lastly, it implements timeout negotiation between client and servant * for the two methods. * Asynchronous calls are implemented using the ...... pattern and the ..... support classes. * For each xxx action defined in the IDL interface two methods are provided: * - xxx() just registers the action and installs the callback * - xxxAction() performs (asyncronously) the action and invokes the callback when finished. * The Lamp::invokeAction method is called by the asynchronous dispatcher whenever there is an * xxx pending action and it calls the xxxAction corresponding method. * * @author Matej Sekoranja, * Jozef Stefan Institute, Slovenia
* @version "@(#) $Id: acsexmplLampImpl.h,v 1.99 2008/10/01 04:30:47 cparedes Exp $" */ class Lamp: public baci::CharacteristicComponentImpl, public virtual POA_acsexmplLamp::Lamp, public baci::ActionImplementator { public: /** * Constructor * * @param name component's name. This is also the name that will be used to find the * configuration data for the component in the Configuration Database. * @param containerServices The pointer to the ContainerServices */ Lamp( const ACE_CString& name, maci::ContainerServices * containerServices); /** * Destructor */ virtual ~Lamp(); /* --------------- [ Action implementator interface ] -------------- */ /** * Action dispatcher function * This function is called whenever an asynchronous request has to be handled. * It receives (as parameters) the description of the function and selects the proper * implementation to call. * @param function Action funtion to be invoked. * @param cob Owner of the action. * @param callbackID ID of the callback to be notified. * @param descIn Callback descriptor (passed by client). * @param value Action data (e.g. value to be set). * @param completion Error handing structure. * @param descOut Callback descriptor which will be passed to client. * @return Request to be performed by BACI *
    *
  • reqNone - Do nothing (action will be kept in queue). *
  • reqInvokeWorking - Invoke Callback::working. *
  • reqInvokeDone - Invoke Callback::done and destroy callback. *
  • reqDestroy - Destroy callback (callback should have been called already by function). *
* @htmlonly
@endhtmlonly */ virtual baci::ActionRequest invokeAction (int function, baci::BACIComponent *cob_p, const int &callbackID, const CBDescIn &descIn, baci::BACIValue *value_p, Completion &completion, CBDescOut &descOut); /** * Implementation of asynchronous acsexmplLamp::Lamp::on() method * This is the function that actually switches on the Lamp * and, when completed, invokes the callback installed by the client * when it requested the action. * @param cob Owner of the action. * @param callbackID ID of the callback to be notified. * @param descIn Callback descriptor (passed by client). * @param value Action data (e.g. value to be set). * @param completion Error handing structure. * @param descOut Callback descriptor which will be passed to client. * @return Request to be performed by BACI. *
    *
  • reqNone - Do nothing (action will be kept in queue). *
  • reqInvokeWorking - Invoke Callback::working. *
  • reqInvokeDone - Invoke Callback::done and destroy callback. *
  • reqDestroy - Destroy callback (callback should has been called already by function). *
* @htmlonly
@endhtmlonly */ virtual baci::ActionRequest onAction (baci::BACIComponent *cob_p, const int &callbackID, const CBDescIn &descIn, baci::BACIValue *value_p, Completion &completion, CBDescOut &descOut); /** * Implementation of asynchrnous acsexmplLamp::Lamp::off() method * This is the function that actually switches off the Lamp * and, when completed, invokes the callback installed by the client * when it requested the action. * @param cob Owner of the action. * @param callbackID ID of the callback to be notified. * @param descIn Callback descriptor (passed by client). * @param value Action data (e.g. value to be set). * @param completion Error handing structure. * @param descOut Callback descriptor which will be passed to client. * @return Request to be performed by BACI. *
    *
  • reqNone - Do nothing (action will be kept in queue). *
  • reqInvokeWorking - Invoke Callback::working. *
  • reqInvokeDone - Invoke Callback::done and destroy callback. *
  • reqDestroy - Destroy callback (callback should has been called already by function). *
* @htmlonly
@endhtmlonly */ virtual baci::ActionRequest offAction (baci::BACIComponent *cob_p, const int &callbackID, const CBDescIn &descIn, baci::BACIValue *value_p, Completion &completion, CBDescOut &descOut); /* --------------------- [ CORBA interface ] ----------------------*/ /** * Switches on the lamp. * Implementation of IDL on() interface. * This method just registers the request in the asyncronous queue, together with the associated callback * and returns control immediatly. * The actual action will be invoked asyncronously by the asynchonous call manager by calling Lamp::onAction * The given callback is used to inform the caller when the action is * performed. * @param callBack Callback when action has finished. * @param desc Callback used for holding information on timeout periods * @htmlonly
@endhtmlonly */ virtual void on (ACS::CBvoid_ptr cb, const ACS::CBDescIn &desc); /** * Switches off the lamp. * Implementation of IDL off() interface. * This method just registers the request in the asyncronous queue, together with the associated callback * and returns control immediatly. * The actual action will be invoked asyncronously by the asynchonous call manager by calling Lamp::offAction * The given callback is used to inform the caller when the action is * performed. * @param callBack Callback when action has finished. * @param desc Callback used for holding information on timeout periods. * @htmlonly
@endhtmlonly */ virtual void off (ACS::CBvoid_ptr cb, const ACS::CBDescIn &desc); /** * Returns a reference to the Brightness property * Implementation of IDL interface for the property. * @htmlonly
@endhtmlonly */ virtual ACS::RWdouble_ptr brightness (); private: /** * m_brightness_sp is the lamp's setable brightness. */ baci::SmartPropertyPointer m_brightness_sp; /** * ALMA C++ coding standards state copy operators should be disabled. */ void operator=(const Lamp&); }; /*\@}*/ /*\@}*/ #endif /* acsexmplLampImpl_h */