---

     

---

CHMengineClass.h

#ifndef __CHM_ENGINE_CLASS_H__
#define __CHM_ENGINE_CLASS_H__
//------------------------------------------------------------------------
// Copyright (C) 1997-2007 iNTERFACEWARE Inc.  All Rights Reserved
//
// Module: CHMengineClass
//
// Description:
// Instance of Chameleon engine.
// The CHMengine object represents an instance of a Chameleon
// engine.  Before it can be used the programmer must
// load a message definition file using the Load method of this object.
//
// Author: Eliot Muir
// Date:   Wed 09/09/1998 
// Revision: $Revision: 1.69 $
//
// Last Edit Date: $Date: 2008-07-28 15:33:19 $
// Source: $Source: /home/cvs/cvsroot/CHM/CHMengineClass.h,v $
//---------------------------------------------------------------------------

#include <CHM/CHMminimumInclude.h>

class CHMenginePrivate;
class CHMoutputLog;
class CHMwrapper;
class CHMtransport;
class CHMdateTime;
class CHMstring;
class CHMtable;

class CHMengine
{
public:
   CHMengine();
   
   explicit CHMengine(CHMengineHandle handle);

   virtual ~CHMengine();

   size_t AckMessageIndex() const;   
   
   size_t buildNumber() const;
   
   const CHMchar* ConfigurationName(size_t ConfigurationIndex) const;
   
   size_t CountOfConfiguration() const;
   
   size_t CountOfMessage() const;

   size_t CountOfTable() const;
   
   size_t CurrentConfigurationIndex() const;


   const CHMengineHandle EngineHandle() const;

   void extendPythonLibraryPath(const char* pPath);

   const CHMchar* generateAck(const CHMchar* pMessage);
   
   void generateXsd( const char* pFilename );
   
   size_t IgnoreMessageIndex() const;

   size_t InConfigurationIndex() const;
   
   virtual void InitiateMessage(const CHMchar* pFlatWire);
   
   CHMboolean IsUsingPassthruMapping() const;
   
   virtual void Load(const CHMchar* pFileName);

   
   CHMoutputLog* Log();
   
   size_t majorVersion() const;
   
   CHMtableHandle MessageHandle(size_t MessageIndex) const;

   const CHMchar* MessageName(size_t MessageIndex) const;

   size_t minorVersion() const;
   
   const CHMchar* NewLine() const;

   size_t OutConfigurationIndex() const;

   void OutputLine(const CHMchar* pLine) const;
   
   virtual void ParseMessage(const CHMchar* pFlatWire, size_t TransportIndex);

   virtual void ParseMessageDynamically(const CHMchar* pFlatWire, 
                                        CHMtable&   Table, 
                                        size_t&     MessageIndex) const;

   virtual void ReplyToMessage(const CHMchar* FlatWire, size_t TransportIndex);

   void SetCurrentConfigurationIndex(size_t Index);
    
   void setDefaultDatabase
   (
      const char* pAPI, 
      const char* pName,
      const char* pUserName,
      const char* pPassword
   );
   
   void SetLog(CHMoutputLog* pLog);
  
   void setPythonKeyValuePair(const char* pKey, const char* pValue);

   void SetRejectBadSegmentGrammarFlag(CHMboolean Flag);
 
   void SetTransport(CHMtransport* pTransport);
     
   void SetWrapper(CHMwrapper* pWrapper);
   
   CHMtableHandle TableHandle(size_t TableIndex) const;
   
   const CHMchar* transformMessage(const CHMchar* pMessage,
                          size_t InConfigIndex,
                          size_t OutConfigIndex,
                          size_t& MessageIndex);

   const char* translateMessageToXml(const char* pFlatWire);

   const char* translateXmlToMessage(const char* pXml);  
   
   const CHMtransport* Transport() const;
   
   CHMtransport* Transport();

   const CHMchar* versionString() const;

   const CHMwrapper* Wrapper() const;

   CHMwrapper* Wrapper();

   
   // This function is deprecated.
   //
   // void OutputStream(IOstrstream& Stream) const;
   
   // This function is deprecated. Use Dump instead. See manual for migration guide.
   //
   // void printOn(IOostream& Stream) const;

   // This function is deprecated. Use Dump instead. See manual for migration guide.
   //
   // void printOn(CHMstring& String) const;

private:
   CHMengine& operator=(const CHMengine& Original); // not allowed
   CHMengine(const CHMengine& Original);            // not allowed
   CHMenginePrivate* pMember;
};

// This function is deprecated. Use Dump instead. See manual for migration guide.
//
// IOostream& operator<<(IOostream& Stream, const CHMengine& Engine);

#endif // end of defensive include

---