fw4spl
Public Member Functions | Protected Member Functions | Friends | List of all members
fwRuntime::IExecutable Struct Referenceabstract

Defines the base executable interface.An executable object is an instance created by an extension point of a plugin. More...

#include <IExecutable.hpp>

+ Inheritance diagram for fwRuntime::IExecutable:

Public Member Functions

virtual FWRUNTIME_API ~IExecutable ()
 Destructor : does nothing.
 
virtual std::shared_ptr< Bundle > getBundle () const noexcept=0
 Retrieves the bundle the executable originates from. More...
 
virtual void setInitializationData (const std::shared_ptr< ConfigurationElement > configuration) noexcept=0
 Initializes the executable instance with the specified configuration element. More...
 

Protected Member Functions

virtual void setBundle (std::shared_ptr< Bundle > bundle)=0
 Updates the bundle the executable originates from. More...
 

Friends

struct Runtime
 

Detailed Description

Defines the base executable interface.

An executable object is an instance created by an extension point of a plugin.

Date
2004-2009

Definition at line 41 of file IExecutable.hpp.

Member Function Documentation

virtual std::shared_ptr<Bundle> fwRuntime::IExecutable::getBundle ( ) const
pure virtualnoexcept

Retrieves the bundle the executable originates from.

Returns
a pointer to the originating bundle.

Implemented in fwRuntime::Executable, and fwRuntime::Plugin.

virtual void fwRuntime::IExecutable::setBundle ( std::shared_ptr< Bundle >  bundle)
protectedpure virtual

Updates the bundle the executable originates from.

Parameters
[in]bundlea pointer to the bundle the executable originates from

Implemented in fwRuntime::Executable, and fwRuntime::Plugin.

Referenced by fwRuntime::Runtime::createExecutableInstance().

+ Here is the caller graph for this function:

virtual void fwRuntime::IExecutable::setInitializationData ( const std::shared_ptr< ConfigurationElement >  configuration)
pure virtualnoexcept

Initializes the executable instance with the specified configuration element.

Parameters
[in]configurationa shared pointer to the configuration element used to trigger this execution

Implemented in fwRuntime::Executable, and fwRuntime::Plugin.

Referenced by fwRuntime::Runtime::createExecutableInstance().

+ Here is the caller graph for this function:

The documentation for this struct was generated from the following files: