doxygen/common_2_action_8hpp_source.html

 // Copyright (C) 2010-2013 von Karman Institute for Fluid Dynamics, Belgium

 //

 // This software is distributed under the terms of the

 // GNU Lesser General Public License version 3 (LGPLv3).

 // See doc/lgpl.txt and doc/gpl.txt for the license text.


 #ifndef cf3_common_Action_hpp

 #define cf3_common_Action_hpp


 #include "common/Component.hpp"

 #include "common/IAction.hpp"


 namespace cf3 {

 namespace common {


 class Common_API Action : public IAction, public Component {


 public: // functions


   Action ( const std::string& name );


   static std::string type_name () { return "Action"; }


   virtual void execute () = 0;


   virtual Action& create_action(const std::string& action_provider, const std::string& name);


   void signal_execute ( common::SignalArgs& node );


 };


 } // common

 } // cf3


 #endif // cf3_common_Action_hpp

cf3::python::name
std::string name(ComponentWrapper &self)
Definition: ComponentWrapper.cpp:340

cf3::common::IAction
Abstract interface for actions. You probably want to use Action as a base to start from...
Definition: IAction.hpp:21

cf3::common::XML::SignalFrame
Manages a set of maps.
Definition: SignalFrame.hpp:31

Component.hpp
Holds the Component class, as well as the ComponentIterator class plus some functions related to comp...

cf3::common::Action::type_name
static std::string type_name()
Get the class name.
Definition: Action.hpp:30

cf3
Top-level namespace for coolfluid.
Definition: Action.cpp:18

cf3::common::Action
Component that executes an action. Implementation of the IAction interface as a component, exposing the execute function as a signal.
Definition: Action.hpp:21

Common_API
#define Common_API
Definition: CommonAPI.hpp:29

cf3::common::Component
Base class for defining CF components.
Definition: Component.hpp:82

IAction.hpp