CoreInterface Class Reference

#include <bbob_interfaces.h>

Inheritance diagram for CoreInterface:

List of all members.

---

Detailed Description

Interface for ALL plugins to the core functions (engine).

For plugins to communicate, there is the "Message Bus". A set of functions to pass data around plugins.

Definition at line 16 of file bbob_interfaces.h.

Public Member Functions
virtual	~CoreInterface ()
virtual void	CoreInit (const BCore *core)=0
virtual void	SaveSettings ()=0
virtual void	Module (const QString name, const QStringList params)=0
virtual QStringList	ModuleList () const =0
virtual BBoB_Channel *	ChannelPointer (const QString mod, const QString input) const =0
virtual BBoB_Module *	ModulePointer (const QString mod) const =0
virtual QMap < QString, QString >	ModuleParams (const QString name) const =0
virtual QMap < QString, QString >	ModuleInputs (const QString name) const =0
virtual QMap < QString, QString >	ModuleOutputs (const QString name) const =0

---

Constructor & Destructor Documentation

virtual CoreInterface::~CoreInterface

(

)

[inline, virtual]

Definition at line 19 of file bbob_interfaces.h.

---

Member Function Documentation

virtual void CoreInterface::CoreInit

(

const BCore *

core

)

[pure virtual]

Initialize with pointer to core class functions

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by BCore::loadPlugins().

virtual void CoreInterface::SaveSettings

(

)

[pure virtual]

Dump all settings in plugin through core settings

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by BCore::savePluginSettings().

virtual void CoreInterface::Module	(	const QString	name,
		const QStringList	params
	)			[pure virtual]

Creates or updates a module with name and params

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

virtual QStringList CoreInterface::ModuleList

(

)

const [pure virtual]

Returns list of loaded module names

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by Config_Portmap::addModules(), and BCore::listModules().

virtual BBoB_Channel* CoreInterface::ChannelPointer	(	const QString	mod,
		const QString	input
	)			const [pure virtual]

Returns a Channel Pointer for connect signals/slots

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by Config_Portmap::addModules(), and BCore::findChannel().

virtual BBoB_Module* CoreInterface::ModulePointer

(

const QString

mod

)

const [pure virtual]

Returns a Module Pointer for access to params

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by BCore::listModules().

virtual QMap<QString, QString> CoreInterface::ModuleParams

(

const QString

name

)

const [pure virtual]

Returns a QMap of parameters and values

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by Config_Portmap::addModules().

virtual QMap<QString, QString> CoreInterface::ModuleInputs

(

const QString

name

)

const [pure virtual]

Returns a QMap of inputs or outputs available for each module, with mime type

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by Config_Portmap::addModules().

virtual QMap<QString, QString> CoreInterface::ModuleOutputs

(

const QString

name

)

const [pure virtual]

Implemented in BusConsolePlugin, ButtonBlockPlugin, FaderBlockPlugin, FmodSystemPlugin, GlExamplePlugin, LightTreePlugin, LiveUpdatePlugin, PluginViewerPlugin, SDLPlugin, SerialPlugin, SoundPlugin, TcpPlugin, TestPlugin, TimeCodePlugin, and UdpPlugin.

Referenced by Config_Portmap::addModules().

---

The documentation for this class was generated from the following file:

• plugins/bbob_interfaces.h

---