enumpropROImpl.h

Go to the documentation of this file.

#ifndef ENUM_IMPL_H
#define ENUM_IMPL_H
/*******************************************************************************
* E.S.O. - ACS project
*
* "@(#) $Id: enumpropROImpl.h,v 1.53 2012/11/20 15:17:07 acaproni Exp $"
*
* who       when      what
* --------  --------  ----------------------------------------------
* bjeram 2004-01-12 changed m_value type from pattern to T
* bjeram 2002-11-18 change to create_monitor to return Monitorpattern (onchange)
* bjeram 2001-11-28 changed to virtual inheritence of PortableServer::RefCountServantBase
* bjeram 2001-10-24 added support for namespaces in enumpropMACRO.idl
* bjeram  19/04/01  created
*/

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include <baciDB.h>
#include <logging.h>
#include <baciROpattern.h>
#include <baciRecovery.h>
#include <enumpropAlarm.h>
#include <baciErrTypeProperty.h>
#include <baciCharacteristicModelImpl.h>
#include "enumpropAlarmSystemMonitorEnumProp.h"

#define HISTORY_SIZE 32


#define ACS_ENUM_T(T) T, T##CB, T##Seq, T##Seq_out, T##Alarm
#define ACS_ENUM_C class T, class TCB, class TSeq, class TSeq_out, class TAlarm, class SK

template <ACS_ENUM_C>
class ROEnumImpl: public virtual PortableServer::RefCountServantBase,
                  public SK, 
                  public baci::CharacteristicModelImpl,
                  public baci::PropertyImplementator,
                  public baci::ActionImplementator 
{

public:


  ROEnumImpl(const ACE_CString& name, baci::BACIComponent *cob, DevIO<T> *devIO=0, bool flagdeldevIO=false);
   
  virtual ~ROEnumImpl();

  virtual int initialization() { return initialization_m; }

  CORBA::Object_ptr getCORBAReference() const 
  { 
    return reference_mp;
  }

  baci::BACIProperty* getProperty() const 
  { 
    return property_mp;
  }

    DevIO<T>* getDevIO() const
        {
            return devIO_mp;
        }
   virtual void destroy();

  /***
   * Implementation of async. get_value method
   */
  virtual baci::ActionRequest getValueAction(baci::BACIComponent* cob, const int& callbackID,
                                                        const CBDescIn& descIn, baci::BACIValue* value,
                                                        Completion& completion, CBDescOut& descOut);

  /* --------------- [ Action implementator interface ] -------------- */

  virtual baci::ActionRequest invokeAction(int function,
                                     baci::BACIComponent* cob, const int& callbackID, 
                                     const CBDescIn& descIn, baci::BACIValue* value, 
                                     Completion& completion, CBDescOut& descOut);

  /* -------------- [ Property implementator interface ] -------------- */

  virtual void getValue(baci::BACIProperty* property,
                        baci::BACIValue* value, 
                        Completion &completion,
                        CBDescOut& descOut);

  /* ----------------------------------------------------------------- */
  /* ---------------------- [ CORBA interface ] ---------------------- */
  /* ----------------------------------------------------------------- */

  /* ------------------ [ CharacteristicModel interface ] ------------------ */

        virtual char * name ();

    /*
        virtual CORBA::Any * get_characteristic_by_name (
            const char * name
            
          );
        
        virtual ACS::stringSeq * find_characteristic (
            const char * reg_exp
            
          );
    */

  /* --------------------- [ Property interface ] --------------------- */

        virtual char * characteristic_component_name ();

        virtual void enable_alarm_system();

        virtual void disable_alarm_system();

        virtual bool alarm_system_enabled();
    
    /*
        virtual CosPropertyService::PropertySet_ptr get_all_characteristics (
            
          );
    */
  
  /* ----------------- [ TypelessProperty interface ] ----------------- */

        virtual char * description ();
        
        virtual char * format ();
        
        virtual char * units ();
        
        virtual ACS::pattern resolution ();
        
        virtual CORBA::Boolean initialize_devio (); 

        virtual void publish_now();
  /* -------------------- [ P interface ] -------------------- */

    virtual ACS::TimeInterval default_timer_trigger ();
        
    virtual ACS::TimeInterval min_timer_trigger ();
        
    virtual T default_value ();
                
    virtual T get_sync (ACSErr::Completion_out c);
        
    virtual void get_async (
                          CBpattern* cb,
                          const ACS::CBDescIn & desc
                     );
        
    virtual CORBA::Long get_history (
        CORBA::Long n_last_values,
        TSeq_out vs,
        ACS::TimeSeq_out ts
    );
        
    virtual ACS::Monitorpattern* create_monitor (
        CBpattern* cb,
        const ACS::CBDescIn & desc
    );
        
    virtual ACS::Monitor* create_postponed_monitor (
        ACS::Time start_time,
        CBpattern* cb,
        const ACS::CBDescIn & desc
        );
    
    virtual ACS::stringSeq * statesDescription (
        ); 
    
    virtual ACS::ConditionSeq * condition (
        );
    
    virtual TSeq * allStates ();

    /* -------------------- [ RO interface ] -------------------- */
  
    virtual TSeq* alarm_on ();
        
    virtual TSeq* alarm_off ();
    
    virtual ACS::Subscription_ptr new_subscription_AlarmEnum (
        ACS::Alarmpattern_ptr cb,
        const ACS::CBDescIn & desc
    ); 
    bool checkAlarm(T state);

    void setAlarmFaultFamily(const char* ff);

    void setAlarmFaultMember(const char* fm);

    const char* getAlarmFaultFamily() { return alarmFaultFamily_m.c_str(); }

    const char* getAlarmFaultMember() { return alarmFaultMember_m.c_str(); }

    int getAlarmLevel() { return this->alarmLevel_m;}


protected:
    
    virtual bool readCharacteristics();

    /* --------------------- [ History support ] ---------------------- */
    
    void addValueToHistory(ACS::Time time, ACS::pattern value);
    
  private:
    
    T state;

    /*  typedef ActionRequest (ROdouble::*ActionFunction)(BACIComponent* cob, const int& callbackID,
        const CBDescIn& descIn, BACIValue* value,
        Completion& completion, CBDescOut& descOut);
    */
    int initialization_m;
    
    bool destroyed_m;
    
    CORBA::Object_ptr reference_mp;
    
    baci::BACIProperty* property_mp;
    
    baci::MonitorenumpropEventDispatcher *monitorEventDispatcher_mp;
    
    baci::AlarmSystemMonitorEnumProp<T, ROEnumImpl<ACS_ENUM_T(T), SK> > *alarmSystemMonitorEnumProp_mp;

    T historyValue_m[HISTORY_SIZE];
    
    ACS::Time historyTime_m[HISTORY_SIZE];
    
    int historyStart_m;
    
    bool historyTurnaround_m;
    
    
    // Typeless property
    ACE_CString  m_description;                         
    ACE_CString  format_m;                              
    ACE_CString  units_m;                               
    ACS::pattern m_resolution;                  
    bool initializeDevIO_m;   
 
    // P
    T   defaultValue_m;                         
    ACS::TimeInterval  defaultTimerTrig_m;              
    ACS::TimeInterval  minTimerTrig_m;                  
    
    ACS::TimeInterval  m_alarm_timer_trig;
    
    ACS::stringSeq    m_statesDescription;
    ACS::ConditionSeq m_condition;      
    
    // RO
    TSeq        m_alarm_on;                     

    TSeq        m_alarm_off;                    

    bool  alarmRaised_m; 

    ACE_CString alarmFaultFamily_m;
    ACE_CString alarmFaultMember_m;
    int alarmLevel_m;
    bool alarmSystemEnabled_m;

#ifdef MAKE_VXWORKS 
    baci::AlarmenumpropEventStrategy<T, ROEnumImpl<ACS_ENUM_T(T), SK>, ACS::Alarmpattern> a;
#endif
    
    DevIO<T> *devIO_mp;  
    bool deldevIO_m;
    T   m_value;
    int m_enumLength;
};

#include "enumpropROImpl.i"

#endif