openfluid::builderext::PluggableBuilderExtension Class Reference

Inheritance diagram for openfluid::builderext::PluggableBuilderExtension:

List of all members.

Public Types
enum	ExtensionType {   WorkspaceTab, ModelessWindow, ModalWindow, SpatialgraphImporter,   InputdataImporter, EventsImporter, ExtraImporter, MixedImporter,   SimulationListener, HomeLauncher }
Public Member Functions
	PluggableBuilderExtension ()
virtual	~PluggableBuilderExtension ()
void	setSimulationBlobAndModel (openfluid::machine::SimulationBlob *Blob, openfluid::machine::ModelInstance *Model)
sigc::signal< void >	signal_ChangedOccurs ()
void	setDefaultConfiguration (std::set< std::string > DefaultConfig)
virtual ExtensionType	getType () const =0
virtual bool	isConfigurable ()
ExtensionConfig_t	getConfiguration () const
void	setConfiguration (const ExtensionConfig_t &Config)
virtual Gtk::Widget *	getExtensionAsWidget ()=0
virtual void	show ()=0
virtual bool	isReadyForShowtime () const
Protected Attributes
ExtensionConfig_t	m_Config
sigc::signal< void >	m_signal_ChangedOccurs
openfluid::machine::SimulationBlob *	mp_SimulationBlob
openfluid::machine::ModelInstance *	mp_ModelInstance

---

Member Enumeration Documentation

enum openfluid::builderext::PluggableBuilderExtension::ExtensionType

Enumerator:

WorkspaceTab
ModelessWindow
ModalWindow
SpatialgraphImporter
InputdataImporter
EventsImporter
ExtraImporter
MixedImporter
SimulationListener
HomeLauncher

---

Constructor & Destructor Documentation

openfluid::builderext::PluggableBuilderExtension::PluggableBuilderExtension

(

)

[inline]

virtual openfluid::builderext::PluggableBuilderExtension::~PluggableBuilderExtension

(

)

[inline, virtual]

---

Member Function Documentation

ExtensionConfig_t openfluid::builderext::PluggableBuilderExtension::getConfiguration

(

)

const [inline]

Retrieves the configuration information from the extension.

Returns:

the configuration information

virtual Gtk::Widget* openfluid::builderext::PluggableBuilderExtension::getExtensionAsWidget

(

)

[pure virtual]

Returns the main widget of the extension. The kind of widget depends on the extension type. This must be overridden in derived extensions

Returns:

a pointer to the main widget

virtual ExtensionType openfluid::builderext::PluggableBuilderExtension::getType

(

)

const [pure virtual]

Returns the type of the extension. This must be overridden.

Returns:

the type of the extension

Implemented in openfluid::builderext::ModelessWindow, openfluid::builderext::WorkspaceTab, openfluid::builderext::EventsImporter, openfluid::builderext::ExtraImporter, openfluid::builderext::HomeLauncher, openfluid::builderext::InputdataImporter, openfluid::builderext::MixedImporter, openfluid::builderext::ModalWindow, openfluid::builderext::SimulationListener, and openfluid::builderext::SpatialgraphImporter.

virtual bool openfluid::builderext::PluggableBuilderExtension::isConfigurable

(

)

[inline, virtual]

Returns true if the extension is configurable, false otherwise.

Returns:

true if the extension is configurable

virtual bool openfluid::builderext::PluggableBuilderExtension::isReadyForShowtime

(

)

const [inline, virtual]

Returns true if the extension is currently ready to use (showtime!). Default is false, but this should be overridden in derived extensions

Returns:

a boolean giving the state of the extension

Reimplemented in openfluid::builderext::HomeLauncher, openfluid::builderext::SimulationListener, and openfluid::builderext::DataImporter.

void openfluid::builderext::PluggableBuilderExtension::setConfiguration

(

const ExtensionConfig_t &

Config

)

[inline]

Gives the configuration information to the extension.

Parameters:

[in]

Config

the configuration information

void openfluid::builderext::PluggableBuilderExtension::setDefaultConfiguration

(

std::set< std::string >

DefaultConfig

)

[inline]

void openfluid::builderext::PluggableBuilderExtension::setSimulationBlobAndModel	(	openfluid::machine::SimulationBlob *	Blob,
		openfluid::machine::ModelInstance *	Model
	)		[inline]

virtual void openfluid::builderext::PluggableBuilderExtension::show

(

)

[pure virtual]

Implemented in openfluid::builderext::WorkspaceTab.

sigc::signal<void> openfluid::builderext::PluggableBuilderExtension::signal_ChangedOccurs

(

)

[inline]

---

Member Data Documentation

ExtensionConfig_t openfluid::builderext::PluggableBuilderExtension::m_Config [protected]

sigc::signal<void> openfluid::builderext::PluggableBuilderExtension::m_signal_ChangedOccurs [protected]

openfluid::machine::ModelInstance* openfluid::builderext::PluggableBuilderExtension::mp_ModelInstance [protected]

openfluid::machine::SimulationBlob* openfluid::builderext::PluggableBuilderExtension::mp_SimulationBlob [protected]