GmPhysicsUserFunctions Class Reference

Base interface class for Physics type plugins to export user functions that can be used to provide attributes / property values. More...

#include <gmPhysics.h>

Inheritance diagram for GmPhysicsUserFunctions:

Collaboration diagram for GmPhysicsUserFunctions:

Public Member Functions
	GmPhysicsUserFunctions (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)
	Constructor.
virtual	~GmPhysicsUserFunctions ()
	Destructor.
virtual const char *	pluginCategory () const
	Returns the plugin category.
virtual const char *	pluginType () const
	Returns the string identifying the plugin object type. Should return the SAME string as the one read from the plugin information file in the objectTypes table. More...
virtual bool	loadPrivateData (LuaTable &table)
	Function called by the model loader to give the object acess to it's private parameters. Should return false only if the received parameter set makes the use of this object impossible.
virtual void	printParameters (const GmLogCategory &logger)
	Asks the object to print its parameters together with the function list with its logger using the requested level.
void	setMesh (const GmMesh *mesh)
	Sets the mesh that this object is bound to.
virtual QStringList	functionList () const =0
	Returns the set of function names exported by this process object.
virtual GmCUserMethod	function (QString funcName) const =0
	Returns the method named funcName or NULL if it doesn't exists.
Public Member Functions inherited from GmPluginObject
	GmPluginObject (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)
	Constructor. More...
virtual	~GmPluginObject ()
	Destructor.
QString	id () const
	Returns the object id.
QString	description () const
	Returns the object description.
QString	pluginTypeName () const
	Returns the hierarchical type name for the plugin object type. See also pluginName() and pluginType().
virtual const char *	pluginName () const =0
	Returns a string identifying the plugin which implements this object. Should return the SAME string as the one read from the plugin information file in the pluginName field.

Protected Member Functions
const GmMesh *	mesh () const
	Returns the mesh that this object is bound to.
Protected Member Functions inherited from GmPluginObject
virtual const GmLogCategory &	logger () const
	Returns the internal logger used by the plugin to emmit messages.
GmSimulationData *	simulationData () const
	Returns a reference to the simulation data object keeping global simulation information.

Private Attributes
const GmMesh *	_mesh
	The mesh that this object is bound to.

Detailed Description

Base interface class for Physics type plugins to export user functions that can be used to provide attributes / property values.

User functions are methods of this class and as so they can access the full context stored in the object.

An object of this class will be instanced per pair (mesh, plugin) and used to call all user fnctions implemented by the same plugin and tied to the same mesh object.

GmPhysicsUserFunctions should be exported by the plugin factory under the object type name 'userFunctions'.

Member Function Documentation

pluginType()

virtual const char* GmPhysicsUserFunctions::pluginType ( ) const

inlinevirtual

Returns the string identifying the plugin object type. Should return the SAME string as the one read from the plugin information file in the objectTypes table.

Notice that this function DOES NOT return the hierarchical name of the plugin object, which is composed by pluginName() + '.' + pluginType(). The hierarchical name can be obtained by a call to pluginTypeName().

Implements GmPluginObject.

---

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

• inc/solution/gmPhysics.h
• src/solution/gmPhysics.cpp