DtBhaveLuaExtension Class Reference

Extensions to the Lua scripting interface that are B-HAVE specific. More...

Inheritance diagram for DtBhaveLuaExtension:

Public Member Functions
	DtBhaveLuaExtension ()
	CTOR.
virtual	~DtBhaveLuaExtension ()
	DTOR.
virtual void	bindLuaFunctions (DtVrfObject *entity, const DtString &scriptId, lua_State *L)
	Binds method for this class to the lua state.
virtual std::string	version () const
	Bound Lua methods.
virtual std::list< std::string >	availableDatabases ()
	List of available database names.
virtual bool	hasPathdata (const std::string &databaseName)
	Indicates whether or not a given database has pathdata 'somwehere' - e.g. pathdata has been successfully loaded.
virtual bool	isPointOnPathdata (const DtLocation3D &location, const std::string &databaseName, std::string &retCode)
	Indicates whether there is valid pathdata at the given location and database.
virtual bool	checkPathConnectivity (const DtLocation3D &startLoc, const DtLocation3D &endLoc, const std::string &databaseName, std::string &retCode)
	Checks for a static topological connection between the two points using the path data present in the given database.
Public Member Functions inherited from DtLuaScriptInterfaceExtension
virtual	~DtLuaScriptInterfaceExtension ()
virtual void	cleanup ()
	Called to cleanup any state.

Static Public Member Functions
static DtLuaScriptInterfaceExtension *	create (void *usr)
	Clones this object.

Additional Inherited Members
Public Types inherited from DtLuaScriptInterfaceExtension
typedef DtLuaScriptInterfaceExtension *(*	CreatorFcn )(void *usr)
	Prototype for DtLuaScriptInterfaceExtension creator function.
typedef std::pair < DtLuaScriptInterfaceExtension::CreatorFcn, void * >	CreatorUserPair

Detailed Description

Extensions to the Lua scripting interface that are B-HAVE specific.

Constructor & Destructor Documentation

DtBhaveLuaExtension::DtBhaveLuaExtension

(

)

CTOR.

virtual DtBhaveLuaExtension::~DtBhaveLuaExtension ( )

virtual

DTOR.

Member Function Documentation

static DtLuaScriptInterfaceExtension* DtBhaveLuaExtension::create ( void *  usr )

static

Clones this object.

Will not check for script id as this method applies to all scripts

virtual void DtBhaveLuaExtension::bindLuaFunctions ( DtVrfObject *  entity, const DtString &  scriptId, lua_State *  L  )

virtual

Binds method for this class to the lua state.

This simple method will send an object console message to the entity that implements this task

Implements DtLuaScriptInterfaceExtension.

virtual std::string DtBhaveLuaExtension::version ( ) const

virtual

Bound Lua methods.

See Lua docs for additional details.

Returns the B-HAVE version loaded.

virtual std::list<std::string> DtBhaveLuaExtension::availableDatabases ( )

virtual

List of available database names.

(i.e. the database names that are considered valid parameters for the databaseName parameter in other functions.)

virtual bool DtBhaveLuaExtension::hasPathdata ( const std::string &  databaseName )

virtual

Indicates whether or not a given database has pathdata 'somwehere' - e.g. pathdata has been successfully loaded.

virtual bool DtBhaveLuaExtension::isPointOnPathdata ( const DtLocation3D &  location, const std::string &  databaseName, std::string &  retCode  )

virtual

Indicates whether there is valid pathdata at the given location and database.

(Note that there is a ~50m vertical tolerance on the location given when using this function.) 'retCode' is a pure-out reference.

virtual bool DtBhaveLuaExtension::checkPathConnectivity ( const DtLocation3D &  startLoc, const DtLocation3D &  endLoc, const std::string &  databaseName, std::string &  retCode  )

virtual

Checks for a static topological connection between the two points using the path data present in the given database.

(Note that there is a ~50m vertical tolerance in the locations given when using this function.) 'retCode' is a pure-out reference.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/bhaveSim/bhaveLuaExtension.h