GemaLuaCoreLib
The GeMA Lua Core library
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
GmLuaCellGroupSet Class Reference

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

#include <gmLuaCellGroupSet.h>

Inheritance diagram for GmLuaCellGroupSet:
Inheritance graph
[legend]
Collaboration diagram for GmLuaCellGroupSet:
Collaboration graph
[legend]

Public Member Functions

 GmLuaCellGroupSet (GmCellMesh *mesh, const QList< int > &groupIds, bool disjoint, const GmLogCategory &logger)
 Constructor. Receives the parameters needed for creating a new cell group set, owned by the proxy object.
 
virtual ~GmLuaCellGroupSet ()
 Destructor.
 
virtual const char * typeName () const
 Returns the object type as will be stored in the object metatable.
 
virtual QString toString () const
 Default method used by the __tostring metamethod to capture the result of tostring() over an object.
 
virtual void fillMetatable (lua_State *L, int index)
 Prepares the object metatable for calling methods.
 
virtual void * getClassMetatableID ()
 Returns an unique identifier to identify an user object as a GmLuaMesh object.
 
GmCellGroupSetcellGroupSet () const
 Returns the wrapped cell.
 
- 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 Attributes

GmCellGroupSet_gs
 The cell group set 'wrapped' by this proxy object.
 
- 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 numCells (lua_State *L)
 Returns the number of cells in the group.
 
int cell (lua_State *L)
 Returns the i'th cell belonging to the group set given an 'i' index parameter (from 1 to numCells())
 
int numNodes (lua_State *L)
 Returns the number of nodes in the cell group set.
 
int node (lua_State *L)
 Returns the i'th node belonging to the group set given an 'i' index parameter (from 1 to numNodes())
 
int cellGroups (lua_State *L)
 Returns a table with cell group names from mesh cell groups belonging to this set. Can be an empty table.
 
int mesh (lua_State *L)
 Returns the associated cell mesh.
 

Additional Inherited Members

- Protected Member Functions inherited from GmLuaObject
 GmLuaObject (const GmLogCategory &logger)
 Construtor protegido. Somente classes derivadas devem ser instanciadas.
 

Detailed Description

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


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