tracer-real-time.h

// -*- mode: c++ -*-
// Copyright 2010, François Bleibel, Thomas Moulard, Olivier Stasse,
// JRL, CNRS/AIST.
//
// This file is part of dynamic-graph.
// dynamic-graph 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, either version 3 of
// the License, or (at your option) any later version.
//
// dynamic-graph 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 GNU
// General Lesser Public License for more details.  You should have
// received a copy of the GNU Lesser General Public License along with
// dynamic-graph. If not, see <http://www.gnu.org/licenses/>.

#ifndef DYNAMIC_GRAPH_TRACER_REAL_TIME_H
# define DYNAMIC_GRAPH_TRACER_REAL_TIME_H
# include <sstream>

# include <dynamic-graph/fwd.hh>
# include <dynamic-graph/tracer.h>
# include <dynamic-graph/config-tracer-real-time.hh>

namespace dynamicgraph
{
  /// \ingroup plugin
  ///
  /// \brief Stream for the tracer real-time.
  class DG_TRACERREALTIME_DLLAPI OutStringStream : public std::ostringstream
  {
  public:
    char* buffer;
    std::streamsize index;
    std::streamsize bufferSize;
    bool full;
    std::string givenname;

  public:
    OutStringStream  ();
    ~OutStringStream  ();

    void resize (const std::streamsize& size);
    bool addData (const char * data, const std::streamoff& size);
    void dump (std::ostream& os);
    void empty ();
  };

  /// \ingroup plugin
  ///
  /// \brief Main class of the tracer real-time plug-in.
  class DG_TRACERREALTIME_DLLAPI TracerRealTime : public Tracer
  {
    DYNAMIC_GRAPH_ENTITY_DECL ();
  public:
    TracerRealTime (const std::string n);
    virtual ~TracerRealTime ()
    {}

    virtual void closeFiles ();
    virtual void trace ();

    void display (std::ostream& os) const;
    DG_TRACERREALTIME_DLLAPI friend std::ostream& operator<<
      (std::ostream& os, const TracerRealTime& t);

    virtual void commandLine (const std::string& cmdLine,
			      std::istringstream& cmdArgs,
			      std::ostream& os);

  protected:
    virtual void openFile (const SignalBase<int>& sig,
			   const std::string& filename);

    virtual void recordSignal (std::ostream& os,
			       const SignalBase<int>& sig);
    void emptyBuffers ();

    void setBufferSize (const int& SIZE)
    {
      bufferSize=SIZE;
    }

    const int& getBufferSize ()
    {
      return bufferSize;
    }

    typedef std::list<std::ofstream*> HardFileList;
    static const int BUFFER_SIZE_DEFAULT = 1048576; //  1Mo

    int bufferSize;
    HardFileList hardFiles;
  };
} // end of namespace dynamicgraph

#endif //! DYNAMIC_GRAPH_TRACER_REAL_TIME_H