VisItPythonConnection.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
 *      _______              __
 *     / ___/ /  ___  __ _  / /  ___
 *    / /__/ _ \/ _ \/  V \/ _ \/ _ \
 *    \___/_//_/\___/_/_/_/_.__/\___/
 *    Please refer to Copyright.txt, in Chombo's root directory.
 */
#endif

#ifndef _VISITPYTHONCONNECTION_H_
#define _VISITPYTHONCONNECTION_H_

#include <string>
#include <vector>
#include <sys/types.h>

#include "NamespaceHeader.H"

// ****************************************************************************
//  Class:  VisItPythonConnection
//
//  Purpose:
//    Raw connection to VisIt's Python command line interface.
//    Allows opening, closing and sending raw strings.
//
//  Programmer:  Jeremy Meredith
//  Creation:    June 12, 2007
//
//  Modifications:
//    Jeremy Meredith, Wed Jul 18 15:38:44 EDT 2007
//    Allow extra launch arguments.
//
// ****************************************************************************
class VisItPythonConnection
{
  public:
                VisItPythonConnection();
               ~VisItPythonConnection();

    // Open the connection; uses VISITHOME or PATH to find visit.
    bool        Open(
              std::vector<std::string> extraargs=std::vector<std::string>());
    // Close the connection.  Sends EOF to the Python CLI as well.
    bool        Close();
    // Send a raw command.  This method appends the newline for you.
    bool        SendCommand(const char *buff);
    // Return true if we have a valid open connection.
    bool        IsOpen();
    // When a function returns an error (false), get the error string.
    std::string GetLastError();

  protected:
    bool        WriteString(const char *buff);
    bool        WaitForPrompt();
  private:
    int         to_cli;
    int         from_cli;

    int         readbufferlen;
    char       *readbuffer;

    pid_t       visitpid;
    std::string error;
};

#include "NamespaceFooter.H"

#endif