LUMIERA.clone/src/proc/engine/engine-diagnostics.hpp
Ichthyostega cd8844b409 clean-up: kill Boost scoped_ptr
std::unique_ptr is a drop-in replacement
2017-01-05 00:56:46 +01:00

115 lines
3.3 KiB
C++

/*
ENGINE-DIAGNOSTICS.hpp - diagnostic facility to investigate engine operation
Copyright (C) Lumiera.org
2011, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
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
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file engine-diagnostics.hpp
** An facility to check and monitor engine operations.
** Once created, an EngineDiagnostics object connects to the EngineService
** interface to activate additional tracing facilities within the engine,
** allowing to watch and verify the creation of individual jobs and further
** engine state parameters.
**
** @see EngineInterface
** @see engine-interface-test.cpp
** @see calc-stream-test.cpp
*/
#ifndef PROC_ENGINE_ENGINE_DIAGNOSTICS_H
#define PROC_ENGINE_ENGINE_DIAGNOSTICS_H
#include "lib/error.hpp"
#include "proc/engine/engine-service.hpp"
//#include "include/dummy-player-facade.h"
//#include "include/display-facade.h"
//#include "proc/engine/calc-stream.hpp"
//#include "proc/mobject/model-port.hpp"
#include "proc/play/timings.hpp"
//#include "proc/play/output-slot.hpp"
//#include "common/instancehandle.hpp"
//#include "lib/singleton-ref.hpp"
//#include "lib/polymorphic-value.hpp"
//#include "lib/depend.hpp"
//
#include <boost/noncopyable.hpp>
//#include <string>
namespace proc {
namespace engine{
// using std::string;
// using lumiera::Subsys;
// using lumiera::Display;
// using lumiera::DummyPlayer;
using proc::play::Timings;
/**************************************************//**
* Render engine diagnostic facility. Creating an instance
* will activate additional tracing facilities within the
* render engine; results may be investigated through
* EngineDiagnostics public functions. The object acts
* like a smart handle, i.e. the tracing facilities will
* be disabled and disconnected when going out of scope.
* @warning not reentrant, no reference-counting.
* At any given time, at most a single instance
* of EngineDiagnostics may be used.
*/
class EngineDiagnostics
: boost::noncopyable
{
EngineService& engine_;
public:
EngineDiagnostics (EngineService& e)
: engine_(e)
{
UNIMPLEMENTED ("attach tracing connector");
engine_.activateTracing();
}
~EngineDiagnostics()
{
TODO ("detach tracing connector");
engine_.disableTracing();
}
/** */
bool
has_scheduled_jobs_for (Timings const& timings)
{
UNIMPLEMENTED ("Engine Diagnostics: query scheduled jobs");
}
};
} // namespace engine
} // namespace proc
#endif