HGL::ControlSource::IControlSource Interface Reference
[Control source plugins]

Interface to the control source subsystem. More...

#include <icontrolsource.h>

List of all members.

Public Types
typedef std::vector< const HGL::Type::IParam * >	PARAMVECTOR
	A vector of Parameter.
Public Member Functions
virtual PARAMVECTOR	getParams (const std::string &procedure) const =0
	Gets the PARAMVECTOR for an given procedure.
Command line options support
virtual struct::poptOption *	getPoptOptions () const
	Get plugin supplied command line options.

---

Detailed Description

Interface to the control source subsystem.

See Control Source Plugins in detail for more information.

See also:

REGISTER_CSPLUGIN

Author:

Heiko Schäfer <heiko@hgl.rangun.de> BSD License

---

Member Typedef Documentation

typedef std::vector<const HGL::Type::IParam *> HGL::ControlSource::IControlSource::PARAMVECTOR

A vector of Parameter.

---

Member Function Documentation

virtual PARAMVECTOR HGL::ControlSource::IControlSource::getParams

(

const std::string &

procedure

)

const [pure virtual]

Gets the PARAMVECTOR for an given procedure.

Parameters:

procedure

the procedure to get the parameters for

Returns:

the PARAMVECTOR for the given procedure

virtual struct ::poptOption* HGL::Common::IPluginPoptOptions::getPoptOptions

(

)

const [virtual, inherited]

Get plugin supplied command line options.

Note:

See http://linux.die.net/man/3/popt for how to create and use the popt structure and Command line options support for details on how to use it in your plugins.

The default implementation returns NULL i.e. it won't provide own command line options

In your POPT_ARG_CALLBACK you can indicate HGL to exit gracefully by throwing HGL::Exception::PoptExitException

Returns:

structure to popt options

Since:

0.4.53