libsidl-dev 1.4.0.dfsg-8build3 / usr / include / cxx / sidl_EnfPolicy.hxx

// 
// File:          sidl_EnfPolicy.hxx
// Symbol:        sidl.EnfPolicy-v0.9.17
// Symbol Type:   class
// Babel Version: 1.4.0 (Revision: 6607 release-1-4-0-branch)
// Release:       $Name:  $
// Revision:      @(#) $Id: $
// Description:   Client-side glue code for sidl.EnfPolicy
// 
// Copyright (c) 2000-2002, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
// Written by the Components Team <components@llnl.gov>
// All rights reserved.
// 
// This file is part of Babel. For more information, see
// http://www.llnl.gov/CASC/components/. Please read the COPYRIGHT file
// for Our Notice and the LICENSE file for the GNU Lesser General Public
// License.
// 
// This program 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) version 2.1 dated February 1999.
// 
// This program 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 terms and
// conditions of the GNU Lesser General Public License for more details.
// 
// You should have recieved a copy of the GNU Lesser General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
// 
// WARNING: Automatically generated; changes will be lost
// 
// 

#ifndef included_sidl_EnfPolicy_hxx
#define included_sidl_EnfPolicy_hxx

#ifndef included_sidl_cxx_hxx
#include "sidl_cxx.hxx"
#endif
// declare class before main #includes
// (this alleviates circular #include guard problems)[BUG#393]
namespace sidl { 

  class EnfPolicy;
} // end namespace sidl

// Some compilers need to define array template before the specializations
namespace sidl {
  template<>
  class array< ::sidl::EnfPolicy >;
}
// 
// Forward declarations for method dependencies.
// 
namespace sidl { 

  class RuntimeException;
} // end namespace sidl

#ifndef included_sidl_cxx_hxx
#include "sidl_cxx.hxx"
#endif
#ifndef included_sidl_EnfPolicy_IOR_h
#include "sidl_EnfPolicy_IOR.h"
#endif
#ifndef included_sidl_BaseClass_hxx
#include "sidl_BaseClass.hxx"
#endif
#ifndef included_sidl_ContractClass_hxx
#include "sidl_ContractClass.hxx"
#endif
#ifndef included_sidl_EnfTraceLevel_hxx
#include "sidl_EnfTraceLevel.hxx"
#endif
#ifndef included_sidl_EnforceFreq_hxx
#include "sidl_EnforceFreq.hxx"
#endif
namespace sidl {
  namespace rmi {
    class Call;
    class Return;
    class Ticket;
  }
  namespace rmi {
    class InstanceHandle;
  }
}
namespace sidl { 

  /**
   * Symbol "sidl.EnfPolicy" (version 0.9.17)
   * 
   * <code>EnfPolicy</code> maintains the current interface
   * contract enforcement policy.
   */
  class EnfPolicy: public virtual ::sidl::BaseClass {

    //////////////////////////////////////////////////
    // 
    // Special methods for throwing exceptions
    // 

  private:
    static 
    void
    throwException0(
      const char* methodName,
      struct sidl_BaseInterface__object *_exception
    )
      // throws:
    ;

    //////////////////////////////////////////////////
    // 
    // User Defined Methods
    // 

  public:

    /**
     * Sets the enforcement policy to always check the specified
     * type(s) of contracts.  This is equivalent to calling
     * setPolicy() with ALWAYS as the enforcement frequency
     * and the specified (or default) contract class.
     * 
     * @param contractClass  Contract classification
     * [Default = ALLCLASSES]
     * @param clearStats      TRUE if enforcement statistics are to be
     * cleared; FALSE otherwise.
     */
    static void
    setEnforceAll (
      /* in */::sidl::ContractClass contractClass,
      /* in */bool clearStats
    )
    ;



    /**
     * Sets the policy options to disable all contract enforcement.
     * This is equivalent to calling setPolicy() with NEVER as the
     * enforcement frequency.
     * 
     * @param clearStats  TRUE if enforcement statistics are to be
     * cleared; FALSE otherwise.
     */
    static void
    setEnforceNone (
      /* in */bool clearStats
    )
    ;



    /**
     * Sets enforcement policy and options.  This method should be
     * invoked directly to avoid the default enforcement behavior.
     * 
     * @param contractClass  Contract classification
     * [Default = ALLCLASSES]
     * @param enforceFreq    Enforcement frequency
     * [Default = ALWAYS]
     * @param interval       Sampling interval representing the
     * period (for PERIODIC) or maximum
     * random number/window (for RANDOM)
     * [Default = 0 if negative specified]
     * @param overheadLimit  Limit on performance overhead [0.0 .. 1.0)
     * [Default = 0.0 (or 0%) if negative]
     * @param appAvgPerCall  Average extra, application-specific
     * execution time, normalized by calls
     * to annotated methods
     * [Default = 0.0 if negative]
     * @param annealLimit    Limit on simulated annealing function
     * to ensure its termination
     * (0.0 .. 2.72]
     * [Default = 2.72 if negative specified]
     * @param clearStats      TRUE if enforcement statistics are to be
     * cleared; FALSE otherwise.
     */
    static void
    setPolicy (
      /* in */::sidl::ContractClass contractClass,
      /* in */::sidl::EnforceFreq enforceFreq,
      /* in */int32_t interval,
      /* in */double overheadLimit,
      /* in */double appAvgPerCall,
      /* in */double annealLimit,
      /* in */bool clearStats
    )
    ;



    /**
     * Returns TRUE if contract enforcement is enabled; FALSE otherwise.
     */
    static bool
    areEnforcing() ;


    /**
     * Returns the contract classification policy option.
     */
    static ::sidl::ContractClass
    getContractClass() ;


    /**
     * Returns the enforcement frequency policy option.
     */
    static ::sidl::EnforceFreq
    getEnforceFreq() ;


    /**
     * Returns the interval for PERIODIC (i.e., the interval) or
     * RANDOM (i.e., the maximum random number).  Returns 0 by default.
     */
    static int32_t
    getSamplingInterval() ;


    /**
     * Returns the desired enforcement overhead limit for
     * performance-driven frequency options (i.e., ADAPTFIT,
     * ADAPTTIMING, and SIMANNEAL).  Returns 0.0 by default.
     */
    static double
    getOverheadLimit() ;


    /**
     * Returns the average assumed execution time associated
     * with the program or application.  Returns 0.0 by default.
     */
    static double
    getAppAvgPerCall() ;


    /**
     * Returns the annealing limit for SIMANNEAL enforcement
     * frequency option.  Returns 0.0 by default.
     */
    static double
    getAnnealLimit() ;


    /**
     * Returns the name, or description, of the enforcement policy.
     * The caller is responsible for calling sidl_String_free()
     * on the name when done with it.
     * 
     * @param useAbbrev   TRUE if the abbreviated name is to be
     * returned.
     */
    static ::std::string
    getPolicyName (
      /* in */bool useAbbrev
    )
    ;



    /**
     * Prints statistics data to the file with the specified name.
     * The file is opened (for append) and closed on each call.
     * 
     * @param filename   Name of the file to which the statistics
     * data should be written.
     * @param header     TRUE if the header line is to be printed
     * prior to the statistics line (for compressed
     * output only).
     * @param prefix     String description for identifying information,
     * if any, intended to preceed the statistics
     * data.  Useful for distinguishing between
     * different objects, for example.
     * @param compressed TRUE if the enforcer state is to be dumped
     * on a single line with semi-colon separators
     * between fields.
     */
    static void
    dumpStats (
      /* in */const ::std::string& filename,
      /* in */bool header,
      /* in */const ::std::string& prefix,
      /* in */bool compressed
    )
    ;



    /**
     * Starts enforcement trace file generation.
     * 
     * @param filename    Name of the destination trace file.
     * @param traceLevel  Level of trace timing and reporting required.
     * [Default = NONE]
     */
    static void
    startTrace (
      /* in */const ::std::string& filename,
      /* in */::sidl::EnfTraceLevel traceLevel
    )
    ;



    /**
     * Returns TRUE if contract enforcement tracing is enabled;
     * FALSE otherwise.
     */
    static bool
    areTracing() ;


    /**
     * Returns the name of the trace file.  If one was not provided,
     * the default name is returned.
     */
    static ::std::string
    getTraceFilename() ;


    /**
     * Returns the level of enforcement tracing.
     */
    static ::sidl::EnfTraceLevel
    getTraceLevel() ;


    /**
     * Terminates enforcement trace file generation.  Takes a final
     * timestamp and logs the remaining trace information.
     */
    static void
    endTrace() ;


    //////////////////////////////////////////////////
    // 
    // End User Defined Methods
    // (everything else in this file is specific to
    //  Babel's C++ bindings)
    // 

  public:
    typedef struct sidl_EnfPolicy__object ior_t;
    typedef struct sidl_EnfPolicy__external ext_t;
    typedef struct sidl_EnfPolicy__sepv sepv_t;

    // default constructor
    EnfPolicy() { }
    // static constructor
    static ::sidl::EnfPolicy _create();


#ifdef WITH_RMI

    // RMI constructor
    static ::sidl::EnfPolicy _create( /*in*/ const std::string& url );

    // RMI connect
    static inline ::sidl::EnfPolicy _connect( /*in*/ const std::string& url ) { 
      return _connect(url, true);
    }

    // RMI connect 2
    static ::sidl::EnfPolicy _connect( /*in*/ const std::string& url, /*in*/ 
      const bool ar  );


#endif /*WITH_RMI*/

    // default destructor
    virtual ~EnfPolicy () { }

    // copy constructor
    EnfPolicy ( const EnfPolicy& original );

    // assignment operator
    EnfPolicy& operator= ( const EnfPolicy& rhs );

    // conversion from ior to C++ class
    EnfPolicy ( EnfPolicy::ior_t* ior );

    // Alternate constructor: does not call addRef()
    // (sets d_weak_reference=isWeak)
    // For internal use by Impls (fixes bug#275)
    EnfPolicy ( EnfPolicy::ior_t* ior, bool isWeak );

    inline ior_t* _get_ior() const throw() {
      return reinterpret_cast< ior_t*>(d_self);
    }

    inline void _set_ior( ior_t* ptr ) throw () { 
      d_self = reinterpret_cast< void*>(ptr);

      if( ptr != NULL ) {
      } else {
      }
    }

    virtual int _set_ior_typesafe( struct sidl_BaseInterface__object *obj,
                                   const ::std::type_info &argtype );

    bool _is_nil() const throw () { return (d_self==0); }

    bool _not_nil() const throw () { return (d_self!=0); }

    bool operator !() const throw () { return (d_self==0); }

    static inline const char * type_name() throw () { return "sidl.EnfPolicy";}

    static struct sidl_EnfPolicy__object* _cast(const void* src);

    // execute member function by name
    void _exec(const std::string& methodName,
               ::sidl::rmi::Call& inArgs,
               ::sidl::rmi::Return& outArgs);
    // exec static member function by name
    static void _sexec(const std::string& methodName,
                       ::sidl::rmi::Call& inArgs,
                       ::sidl::rmi::Return& outArgs);


    /**
     * Get the URL of the Implementation of this object (for RMI)
     */
    ::std::string
    _getURL() // throws:
    //    ::sidl::RuntimeException
    ;


    /**
     * Method to enable/disable method hooks invocation.
     */
    void
    _set_hooks (
      /* in */bool enable
    )
    // throws:
    //    ::sidl::RuntimeException
    ;


    /**
     * Static Method to enable/disable method hooks invocation.
     */
    static void
    _set_hooks_static (
      /* in */bool enable
    )
    // throws:
    //    ::sidl::RuntimeException
    ;


    /**
     * Method to enable/disable interface contract enforcement.
     */
    void
    _set_contracts (
      /* in */bool enable,
      /* in */const ::std::string& enfFilename,
      /* in */bool resetCounters
    )
    // throws:
    //    ::sidl::RuntimeException
    ;


    /**
     * Static Method to enable/disable interface contract enforcement.
     */
    static void
    _set_contracts_static (
      /* in */bool enable,
      /* in */const ::std::string& enfFilename,
      /* in */bool resetCounters
    )
    // throws:
    //    ::sidl::RuntimeException
    ;


    /**
     * Method to dump contract enforcement statistics.
     */
    void
    _dump_stats (
      /* in */const ::std::string& filename,
      /* in */const ::std::string& prefix
    )
    // throws:
    //    ::sidl::RuntimeException
    ;


    /**
     * Static Method to dump contract enforcement statistics.
     */
    static void
    _dump_stats_static (
      /* in */const ::std::string& filename,
      /* in */const ::std::string& prefix
    )
    // throws:
    //    ::sidl::RuntimeException
    ;

    // return true iff object is remote
    bool _isRemote() const { 
      ior_t* self = const_cast<ior_t*>(_get_ior() );
      struct sidl_BaseInterface__object *throwaway_exception;
      return (*self->d_epv->f__isRemote)(self, &throwaway_exception) == TRUE;
    }

    // return true iff object is local
    bool _isLocal() const {
      return !_isRemote();
    }

  protected:
    // Pointer to external (DLL loadable) symbols (shared among instances)
    static const ext_t * s_ext;

  public:
    static const ext_t * _get_ext() throw ( ::sidl::NullIORException );

    static const sepv_t * _get_sepv() {
      return (*(_get_ext()->getStaticEPV))();
    }

  }; // end class EnfPolicy
} // end namespace sidl

extern "C" {


#pragma weak sidl_EnfPolicy__connectI

  /**
   * RMI connector function for the class. (no addref)
   */
  struct sidl_EnfPolicy__object*
  sidl_EnfPolicy__connectI(const char * url, sidl_bool ar, struct 
    sidl_BaseInterface__object **_ex);


} // end extern "C"
namespace sidl {
  // traits specialization
  template<>
  struct array_traits< ::sidl::EnfPolicy > {
    typedef array< ::sidl::EnfPolicy > cxx_array_t;
    typedef ::sidl::EnfPolicy cxx_item_t;
    typedef struct sidl_EnfPolicy__array ior_array_t;
    typedef sidl_interface__array ior_array_internal_t;
    typedef struct sidl_EnfPolicy__object ior_item_t;
    typedef cxx_item_t value_type;
    typedef value_type reference;
    typedef value_type* pointer;
    typedef const value_type const_reference;
    typedef const value_type* const_pointer;
    typedef array_iter< array_traits< ::sidl::EnfPolicy > > iterator;
    typedef const_array_iter< array_traits< ::sidl::EnfPolicy > > 
      const_iterator;
  };

  // array specialization
  template<>
  class array< ::sidl::EnfPolicy >: public interface_array< array_traits< 
    ::sidl::EnfPolicy > > {
  public:
    typedef interface_array< array_traits< ::sidl::EnfPolicy > > Base;
    typedef array_traits< ::sidl::EnfPolicy >::cxx_array_t          cxx_array_t;
    typedef array_traits< ::sidl::EnfPolicy >::cxx_item_t           cxx_item_t;
    typedef array_traits< ::sidl::EnfPolicy >::ior_array_t          ior_array_t;
    typedef array_traits< ::sidl::EnfPolicy >::ior_array_internal_t 
      ior_array_internal_t;
    typedef array_traits< ::sidl::EnfPolicy >::ior_item_t           ior_item_t;

    /**
     * conversion from ior to C++ class
     * (constructor/casting operator)
     */
    array( struct sidl_EnfPolicy__array* src = 0) : Base(src) {}

    /**
     * copy constructor
     */
    array( const array< ::sidl::EnfPolicy >&src) : Base(src) {}

    /**
     * assignment
     */
    array< ::sidl::EnfPolicy >&
    operator =( const array< ::sidl::EnfPolicy >&rhs ) { 
      if (d_array != rhs._get_baseior()) {
        if (d_array) deleteRef();
        d_array = const_cast<sidl__array *>(rhs._get_baseior());
        if (d_array) addRef();
      }
      return *this;
    }

  };
}

#endif