Provides a default fwRuntime::IExecutable interface implementation.This class provides a default implementation of the fwRuntime::IExecutable interface and is intended to be used as base class for user defined executable classes being exported by bundles. More...

#include <Executable.hpp>

Inheritance diagram for fwRuntime::Executable:

Collaboration diagram for fwRuntime::Executable:

Public Member Functions
FWRUNTIME_API const std::shared_ptr< ConfigurationElement >	getInitializationData () const noexcept
	Retrieves the executable's initialization data. More...

Overrides.
virtual FWRUNTIME_API std::shared_ptr< Bundle >	getBundle () const noexcept
	Retrieves the bundle the executable originates from. More...

virtual FWRUNTIME_API void	setInitializationData (const std::shared_ptr< ConfigurationElement > configuration) noexcept
	Initializes the executable instance with the specified configuration element. More...

Public Member Functions inherited from fwRuntime::IExecutable
virtual FWRUNTIME_API	~IExecutable ()
	Destructor : does nothing.

Protected Member Functions
virtual FWRUNTIME_API void	setBundle (std::shared_ptr< Bundle > bundle)
	Updates the bundle the executable originates from. More...

Detailed Description

Provides a default fwRuntime::IExecutable interface implementation.

This class provides a default implementation of the fwRuntime::IExecutable interface and is intended to be used as base class for user defined executable classes being exported by bundles.

Date: 2004-2009

Definition at line 32 of file Executable.hpp.

Member Function Documentation

std::shared_ptr< Bundle > fwRuntime::Executable::getBundle ( ) const

virtualnoexcept

Retrieves the bundle the executable originates from.

Returns: a pointer to the originating bundle.

Implements fwRuntime::IExecutable.

Definition at line 16 of file Executable.cpp.

const ConfigurationElement::sptr fwRuntime::Executable::getInitializationData ( ) const

noexcept

Retrieves the executable's initialization data.

Returns: a shared pointer to the configuration element being the initialization data of the executable or null when none

Definition at line 23 of file Executable.cpp.

void fwRuntime::Executable::setBundle ( std::shared_ptr< Bundle > bundle )

protectedvirtual

Updates the bundle the executable originates from.

Parameters

[in] bundle a pointer to the bundle the executable originates from

Implements fwRuntime::IExecutable.

Definition at line 30 of file Executable.cpp.

void fwRuntime::Executable::setInitializationData ( const std::shared_ptr< ConfigurationElement > configuration )

virtualnoexcept

Initializes the executable instance with the specified configuration element.

Parameters

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

Implements fwRuntime::IExecutable.

Definition at line 37 of file Executable.cpp.

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation