+/*
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ # pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ # This software is governed by the CeCILL-B license under French law and
+ # abiding by the rules of distribution of free software. You can use,
+ # modify and/ or redistribute the software under the terms of the CeCILL-B
+ # license as circulated by CEA, CNRS and INRIA at the following URL
+ # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+ # or in the file LICENSE.txt.
+ #
+ # As a counterpart to the access to the source code and rights to copy,
+ # modify and redistribute granted by the license, users are provided only
+ # with a limited warranty and the software's author, the holder of the
+ # economic rights, and the successive licensors have only limited
+ # liability.
+ #
+ # The fact that you are presently reading this means that you have had
+ # knowledge of the CeCILL-B license and that you accept its terms.
+ # ------------------------------------------------------------------------ */
+
+
/*=========================================================================
Program: bbtk
Module: $RCSfile: bbtkBlackBox.h,v $
Language: C++
- Date: $Date: 2009/10/05 22:44:48 $
- Version: $Revision: 1.29 $
+ Date: $Date: 2012/11/16 08:49:01 $
+ Version: $Revision: 1.34 $
=========================================================================*/
-/* ---------------------------------------------------------------------
-
-* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
-* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
-*
-* This software is governed by the CeCILL-B license under French law and
-* abiding by the rules of distribution of free software. You can use,
-* modify and/ or redistribute the software under the terms of the CeCILL-B
-* license as circulated by CEA, CNRS and INRIA at the following URL
-* http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
-* or in the file LICENSE.txt.
-*
-* As a counterpart to the access to the source code and rights to copy,
-* modify and redistribute granted by the license, users are provided only
-* with a limited warranty and the software's author, the holder of the
-* economic rights, and the successive licensors have only limited
-* liability.
-*
-* The fact that you are presently reading this means that you have had
-* knowledge of the CeCILL-B license and that you accept its terms.
-* ------------------------------------------------------------------------ */
-
/**
#include <set>
// Signal/slot mechanism for output change events
-#include <boost/signal.hpp>
+#include <boost/signals2/signal.hpp>
#include <boost/bind.hpp>
#define bbtkBlackBoxMessage(key,level,mess) \
- bbtkMessage(key,level,"["<<bbGetName()<<"] "<<mess)
+ bbtkMessage(key,level,"["<<bbGetTypeName()<<":"<<bbGetName()<<"] "<<mess)
#define bbtkBlackBoxDebugMessage(key,level,mess) \
- bbtkDebugMessage(key,level,"["<<bbGetName()<<"] "<<mess)
+ bbtkDebugMessage(key,level,"["<<bbGetTypeName()<<":"<<bbGetName()<<"] "<<mess)
namespace bbtk
{
-
struct Void { Void(int = 0) {} };
class Factory;
class Connection;
class BlackBoxOutputConnector;
-
-
class BBTK_EXPORT BlackBox : public Object
{
BBTK_ABSTRACT_OBJECT_INTERFACE(BlackBox);
//==================================================================
// Types
//==================================================================
- typedef boost::signals::trackable OutputChangeObserverType;
- typedef boost::signal<void (bbtk::BlackBox::Pointer,
+ typedef boost::signals2::trackable OutputChangeObserverType;
+ typedef boost::signals2::signal<void (bbtk::BlackBox::Pointer,
const std::string&,
IOStatus)> OutputChangeSignalType;
typedef OutputChangeSignalType::slot_function_type
/// Sets the value of the input 'BoxProcessMode'
void bbSetInputBoxProcessMode(std::string a) { bbmBoxProcessMode = a; }
/// The possible values of the input 'BoxProcessMode'
- typedef enum
- {
- Pipeline,
- Always,
- Reactive
- }
+
+ typedef enum
+ {
+ bbPipeline,
+ bbAlways,
+ bbReactive,
+ bbManual
+ }
BoxProcessModeValue;
+
/// Returns the "decoded" value of the input "BoxProcessMode"
BoxProcessModeValue bbGetBoxProcessModeValue() const;
/// Returns true iff the input 'BoxProcessMode' is set to 'Reactive' (or a synonym)
virtual bool bbBoxProcessModeIsReactive() const;
/// Returns true iff the input 'BoxProcessMode' is set to 'Always' (or a synonym)
virtual bool bbBoxProcessModeIsAlways() const;
+ /// Returns true iff the input 'BoxProcessMode' is set to 'Manual' (or a synonym)
+ virtual bool bbBoxProcessModeIsManual() const;
/// Returns the value of the input 'BoxExecute'
Void bbGetInputBoxExecute() { return Void(); }
/// Sets the value of the input 'BoxExecute'
- void bbSetInputBoxExecute(Void = 0) {}
+ void bbSetInputBoxExecute(Void = 0) { }
/// Returns the value of the output 'BoxChange'
Void bbGetOutputBoxChange() { return Void(); }
/// Sets the value of the output 'BoxChange'
- void bbSetOutputBoxChange(Void = 0) { }
+ void bbSetOutputBoxChange(Void = 0) { }
//@}
//==================================================================
-
-
-
virtual void bbPrintHelp(BlackBox::Pointer parentblackbox,
int detail, int level
);
protected:
-
-
//==================================================================
/// @name User redefinable methods
/// Virtual methods which can be redefined by inherited classes
//@{
-
//==================================================================
/// User can redefine this method to set
/// the default values of the box inputs and outputs
//==================================================================
-
-
//==================================================================
/// Write Graphviz-dot description in file.
bool inputoutput,
int detail, int level);
-
-
virtual BlackBox::Pointer bbFindBlackBox(const std::string &blackboxname)
- { return BlackBox::Pointer();}
+ { return BlackBox::Pointer();}
virtual void Check(bool recursive = true);
-
-
-
//==================================================================
// PROTECTED PART : ACCESSIBLE TO THE BlackBox DEVELOPER
// (IN INHERITED CLASSES)
//==================================================================
/// Computes the final IOStatus of inputs and outputs after processing
- void bbComputePostProcessStatus();
+virtual void bbComputePostProcessStatus();
//@}
//==================================================================
//@}
//==================================================================
-
-
private:
//==================================================================
friend class Connection;
//@{
/// Connects the input <name> to the connection c
- virtual void bbConnectInput( const std::string& name,
- Connection* c);
+ virtual void bbConnectInput( const std::string& name, Connection* c);
/// Connects the output <name> to the connection c
- virtual void bbConnectOutput( const std::string& name,
- Connection* c);
+ virtual void bbConnectOutput( const std::string& name, Connection* c);
/// Disconnects the input <name> from the connection c
- virtual void bbDisconnectInput( const std::string& name,
- Connection* c);
+ virtual void bbDisconnectInput( const std::string& name, Connection* c);
/// Disconnects the output <name> from the connection c
- virtual void bbDisconnectOutput( const std::string& name,
- Connection* c);
+ virtual void bbDisconnectOutput( const std::string& name, Connection* c);
//@}
//==================================================================
/// which means execute in response to an input change
virtual bool bbCanReact() const;
-
-
-
-
/// Returns true iff the box is executing
bool bbGetExecuting() const { return bbmExecuting; }
/// Sets the bbmExecuting bool returned by bbGetExecuting
void bbSetExecuting(bool b) { bbmExecuting = b; }
-
-
- protected:
-
//==================================================================
protected:
/// \return The number of remaining references on the object after the call (if meaningfull...): used by bbtk to warn a user if another smart pointing system is still holding the object...
//JCP 21-09-20 09 delete this throws and exception change due to compiler version changing and boost version
- virtual int bbDelete() {// delete this;
- return 0; }
+ virtual int bbDelete() { delete this;
+ return 0; }
//==================================================================
/// 0 : "Pipeline" mode
/// 1 : "Always" mode
/// 2 : "Reactive" mode
+ /// 3 : "Manual" mode
std::string bbmBoxProcessMode;
/// The parent of the black box in the ComplexBlackBox hierarchy
BlackBox::WeakPointer bbmParent;
/// Map that contains the input connectors of the black box
InputConnectorMapType mInputConnectorMap;
//==================================================================
-
-
+
+
+ bool bbLetRecursiveExecuteManualMode;
};
// Class BlackBox
-
/// Convenient macro to create output observer callbacks (freehand functions) from object and method pointer (see samples/SampleOutputObserver)
#define BBTK_MAKE_OUTPUT_OBSERVER(OBJECT,METHOD) \
boost::bind( METHOD, OBJECT, _1, _2, _3)
-
-
-
-
}
// namespace bbtk
#endif
-
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff