LUMIERA.clone/tests/core/proc/control/command-basic-test.cpp
Ichthyostega 974c670d41 fix **** in doxygen comments
to make them stand out more prominently, some entity comments
where started with a line of starts. Unfortunately, doxygen
(and javadoc) only recogise comments which are started exactly
with /**

This caused quite some comments to be ignored by doxygen.
Credits to Hendrik Boom for spotting this problem!

A workaround is to end the line of stars with *//**
2013-10-24 23:06:36 +02:00

124 lines
3.4 KiB
C++

/*
CommandBasic(Test) - checking simple ProcDispatcher command definition and execution
Copyright (C) Lumiera.org
2009, 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.
* *****************************************************/
#include "lib/test/run.hpp"
#include "proc/control/command-def.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/p.hpp"
#include <cstdlib>
using std::rand;
namespace proc {
namespace control {
namespace test {
using lib::P;
using lib::time::Time;
using lib::time::TimeVar;
using lib::time::TimeValue;
namespace { // functions to be invoked through the command system
void
operate (P<TimeVar> dummyObj, int randVal)
{
*dummyObj += TimeValue(randVal);
}
TimeVar
capture (P<TimeVar> dummyObj, int)
{
return *dummyObj;
}
void
undoIt (P<TimeVar> dummyObj, int, TimeVar oldVal)
{
*dummyObj = oldVal;
}
}
/***********************************************************************//**
* @test basic usage of the Proc-Layer command dispatch system.
* Shows how to define a simple command inline and how to
* trigger execution and UNDO. Verifies the command action
* takes place and is reverted again by the UNDO function.
*
* This is a simplified demonstration. Usually, commands would be defined
* in bulk and without specifying parameters. Later, typically client code
* accesses a handle by ID, binds to the concrete argument and dispatches
* the invocation. Note in this example that by using a smart-ptr as
* argument allows accessing an object by reference and late binding.
*
* @see control::Command
* @see control::CommandDef
* @see mobject::ProcDispatcher
*/
class CommandBasic_test : public Test
{
virtual void
run (Arg)
{
int randVal ((rand() % 10) - 5);
Time five(TimeValue(5));
TimeValue randomTime(randVal);
P<TimeVar> obj (new TimeVar(five));
CommandDef ("test.command1")
.operation (operate)
.captureUndo (capture)
.undoOperation (undoIt)
.bind (obj, randVal)
;
Command ourCmd = Command::get("test.command1");
// invoke the command
CHECK (*obj == five);
ourCmd();
CHECK (*obj == five + randomTime);
// undo the effect of the command
ourCmd.undo();
CHECK (*obj == five);
}
};
/** Register this test class... */
LAUNCHER (CommandBasic_test, "unit controller");
}}} // namespace proc::control::test