---

toption.h

/*
 * Copyright (c) 1991-2006 TIBCO Software Inc.
 * All rights reserved.
 * For more information, please contact:
 * TIBCO Software Inc., Palo Alto, California, USA
 *
 * $Id: //dev/packages/tpsi/cpsi/dev/68/src/rtworks/toption.h#1 $
 */

#ifndef _T_OPTION_H_
#define _T_OPTION_H_

#include <rtworks/ipc.h>
#include <rtworks/tex.h>
#include <rtworks/types.h>
#include <rtworks/tcallbck.h>

namespace SmartSockets {

  class T_IPCX_API OptionException : public Exception {

  public:
      OptionException () {}

      virtual ~OptionException () throw() {}
  };

  class T_IPCX_API Option;

  class T_IPCX_API OptionChangeCallBack
  {
    public:

      typedef void (OptionChangeCallBack::* Handler) (
        CallBack < OptionChangeCallBack > * callBack,
        void* newVal,
        Option & opt);

      virtual void onChange (
        CallBack < OptionChangeCallBack > * callBack,
        void* newVal,
        Option& opt);
  };


  class T_IPCX_API Option
  {

  public:
    Option (T_OPTION opt) throw (OptionException);

    Option (const char* name) throw (OptionException);

    static Option create(const char* name,T_OPT_TYPE optType ) 
          throw (OptionException);

    virtual ~Option () throw() {}
  
    static void destroyOption (const char* name) throw (OptionException);
  
    bool getBool () const throw (OptionException);
  
    void setBool (bool value) throw (OptionException);
  
    const char *getEnum () const throw (OptionException);
  
    void setEnum (const char * value) throw (OptionException);
  
    T_STR_LIST getEnumList() const throw (OptionException);
  
    void setEnumList (T_STR_LIST value) throw (OptionException);

    real8 getReal8 () const throw (OptionException);
  
    void setReal8 (real8 value) throw (OptionException);

    int4 getInt4 () const throw (OptionException);
  
    void setInt4 (int4 value) throw (OptionException);

    const char * getString () const throw (OptionException);
  
    void setString (const char * value) throw (OptionException);
  
    T_STR_LIST getStringList () const throw (OptionException);
  
    void setStringList (T_STR_LIST value) throw (OptionException);
 
    T_OPT_TYPE getType () const throw (OptionException);
  
    bool isKnown () const throw (OptionException);
  
    void setUnKnown () throw (OptionException);

    bool getReadOnly () const throw (OptionException);
  
    void setReadOnly (bool is_read_only) throw (OptionException);
  
    bool getRequired () const throw (OptionException);
  
    void setRequired (bool is_required) throw (OptionException);

    const char* getName () throw (OptionException);

    void legValAdd (const char * value) throw (OptionException);
  
    CallBack <OptionChangeCallBack> * optionChangeCbCreate(OptionChangeCallBack * impl,
                                                           void* arg = NULL)
                          throw (OptionException);

  private:

    T_OPTION _opt;

  protected:
    static void T_ENTRY1 optionChangeCbDelegator(T_OPTION,
                                                 T_OPTION_CHANGE_CB_DATA,
                                                 T_CB_ARG);
  };
  
} //namespace SmartSockets

#endif //_T_OPTION_H_

---