GmLuaValueAccessor Class Reference

A proxy class to export GmValueAccessor methods to the Lua environment. More...

#include <gmLuaValueAccessor.h>

Inheritance diagram for GmLuaValueAccessor:

Collaboration diagram for GmLuaValueAccessor:

Public Member Functions
	GmLuaValueAccessor (GmValueAccessor *ac, const GmLogCategory &logger, bool ownership=true)
	Constructor.
virtual const char *	typeName () const
	Returns the object type as will be stored in the object metatable.
virtual void *	getClassMetatableID ()
	Returns an unique identifier to identify an user object as a GmValueAccessor object.
virtual void	fillMetatable (lua_State *L, int index)
	Prepares the object metatable for calling methods.
Public Member Functions inherited from GmLuaAccessorBase< GmValueAccessor >
virtual	~GmLuaAccessorBase ()
	Destructor.
virtual QString	toString () const
	Default method used by the __tostring metamethod to capture the result of tostring() over an object.
GmValueAccessor *	accessor () const
	Returns the wrapped accessor.
Public Member Functions inherited from GmLuaObject
virtual	~GmLuaObject ()
	Destrutor.
virtual void	populateMetatable (lua_State *L, int index)
	Fills the object metatable to allow for the proxy to export its methods.
QVariant	ptrToVariant ()
	Constructs a QVariant storing a POINTER to the current object.
void	ref ()
	Increments the object reference count. Use with care.

Protected Member Functions
virtual int	parseIndex (lua_State *L, int stackPos, QString fname) const
	Parses and checks an int index.
Protected Member Functions inherited from GmLuaAccessorIndex< GmValueAccessor, int >
	GmLuaAccessorIndex (GmValueAccessor *ac, const GmLogCategory &logger, bool ownership)
	Constructor. Receives the ValueAccessor to be wrapped. More...
Protected Member Functions inherited from GmLuaAccessorBase< GmValueAccessor >
	GmLuaAccessorBase (GmValueAccessor *ac, const GmLogCategory &logger, bool ownership)
	Constructor. Receives the ValueAccessor to be wrapped. More...
void	parseCoord (lua_State *L, int stackPos, QString fname, GmVector &coord)
	An auxiliary function used to parse a coordinate table / object from the lua stack. More...
void	parseOptions (lua_State *L, int stackPos, Options &opt)
	Aux function to parse print options for the valueStr() call if the object at stackPos is a table.
void	pushResult (lua_State *L, const double *val)
	Pushes an accessor result on the stack. Value can be pushed as a number (scalar) or as a matrix.
Protected Member Functions inherited from GmLuaObject
	GmLuaObject (const GmLogCategory &logger)
	Construtor protegido. Somente classes derivadas devem ser instanciadas.

Protected Attributes
bool	_isGhostAc
	Flags stating if the current accessor accepts ghost indices or not.
Protected Attributes inherited from GmLuaAccessorBase< GmValueAccessor >
GmValueAccessor *	_ac
	The wrapped value accessor object.
bool	_owner
	Do we own the accessor?
Protected Attributes inherited from GmLuaObject
const GmLogCategory &	_logger
	A logger used by the proxy when needed.
QAtomicInteger< int >	_refCount
	Lua objects are reference counted to enable sharing them among different states. This is needed to allow for passing objects as parameters in a parallel call. The garbage collection method releases memory only for the last reference.

Private Member Functions
int	adjustLinearIndex (lua_State *L)
	Returns the adjusted linear index when working with accessors for ghost only data sets. More...
int	value (lua_State *L)
	Returns the scalar, vector or matrix value at the specified index. More...
int	valueStr (lua_State *L)
	Returns the value at the given index converted to a string (even for multivalued values). More...

Detailed Description

A proxy class to export GmValueAccessor methods to the Lua environment.

Member Function Documentation

adjustLinearIndex()

int GmLuaValueAccessor::adjustLinearIndex ( lua_State *  L )

private

Returns the adjusted linear index when working with accessors for ghost only data sets.

Parameters are the original index and the mesh or the original index and the index of the first mesh ghost node.

Returns nil if the linear index is out of the accessor range (a ghost index for a geometry only accessor or a geometry index for a ghost only accessor).

value()

int GmLuaValueAccessor::value ( lua_State *  L )

private

Returns the scalar, vector or matrix value at the specified index.

Stack parameters: index

IMPORTANT: Following Lua spirit, the index is ONE based (and not zero based as in C)

The returned value can be a single number for scalar values or a vector/matrix object for other value types.

valueStr()

int GmLuaValueAccessor::valueStr ( lua_State *  L )

private

Returns the value at the given index converted to a string (even for multivalued values).

Stack parameters: index, optional options table. IMPORTANT: Following Lua spirit, the index is ONE based (and not zero based as in C)

The options table can have the following optional fields: evalFunctions – Should we evaluate functions or do we print its name? Default = false defNil – Should we print default values as 'nil'? Default = false format – Printf like format string (ex: '12.4f')

---

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

• inc/gmLuaValueAccessor.h
• src/gmLuaValueAccessor.cpp