sf::ProjectScriptObject Class Reference

Object for scripts to interact with the inspection project. More...

#include <ProjectScriptObject.h>

Inheritance diagram for sf::ProjectScriptObject:

Collaboration diagram for sf::ProjectScriptObject:

Public Member Functions
	ProjectScriptObject (const char *type_name)
	Constructor.
	~ProjectScriptObject () override
	Virtual overridden destructor.
void	AddScriptParam (const std::string &name, Variable *variable)
	Adds the passed variable as a parameter in the script.
Public Member Functions inherited from sf::ScriptObject
	ScriptObject (const char *type_name, ScriptObject *parent=nullptr)
virtual	~ScriptObject ()=default
	Virtual destructor which can be overloaded to clean up objects.
virtual std::string	getStatusText ()
	Gets the status text of this object for debugging purposes.
int	getRefCount () const
	Gets the reference count.
	operator Value () const
	Cast operator to be able to return this instance as a Value.
std::string	getTypeName () const
	Returns the type name Set at the constructor.
ScriptObject *	getParent ()
	Gets the script object owner.
const ScriptObject *	getParent () const
	Gets the script object owner.
ScriptObject *	castToObject (const Value &value)
	Casts a sf::Value::vitCustom typed sf::Value to a ScriptObject typed pointer.

Protected Member Functions
const IdInfo *	getInfo (const std::string &name) const override
	Overridden from base class.
bool	getSetValue (const IdInfo *info, Value *value, Value::vector_type *params, bool flag_set) override
	Overridden from base class.
void	destroyObject (bool &should_delete) override
	Overridden from base class.
Protected Member Functions inherited from sf::ScriptObject
void	makeParent (ScriptObject *so)
	Makes this object the owner of the other object.
void	setParent (ScriptObject *parent)
	Sets the owner to the pass script object.

Additional Inherited Members
Public Types inherited from sf::ScriptObject
enum	EIdentifier {   idUnknown = 0 , idConstant , idVariable , idFunction ,   idTypedef , idKeyword }
	Keyword identifiers. More...
typedef std::string::size_type	pos_type
	Source position type.
typedef ssize_t	ip_type
	Instruction pointer type.
Static Public Member Functions inherited from sf::ScriptObject
static const IdInfo *	getInfoUnknown ()
	Returns the static Info structure for unknowns.

Detailed Description

Object for scripts to interact with the inspection project.

Constructor & Destructor Documentation

ProjectScriptObject()

sf::ProjectScriptObject::ProjectScriptObject ( const char *  type_name )

explicit

Constructor.

Parameters

type_name

~ProjectScriptObject()

sf::ProjectScriptObject::~ProjectScriptObject ( )

override

Virtual overridden destructor.

Member Function Documentation

AddScriptParam()

void sf::ProjectScriptObject::AddScriptParam	(	const std::string &	name,
		Variable *	variable
	)

Adds the passed variable as a parameter in the script.

Parameters

name	Name in the script to access the parameter.
variable	Attached variable pointer.

destroyObject()

void sf::ProjectScriptObject::destroyObject ( bool &  should_delete )

overrideprotectedvirtual

Overridden from base class.

Implements sf::ScriptObject.

getInfo()

const IdInfo * sf::ProjectScriptObject::getInfo ( const std::string &  name ) const

overrideprotectedvirtual

Overridden from base class.

Implements sf::ScriptObject.

Reimplemented in sf::ScanBinder, and sf::ScanMethod.

getSetValue()

bool sf::ProjectScriptObject::getSetValue ( const IdInfo *  info, Value *  value, Value::vector_type *  params, bool  flag_set  )

overrideprotectedvirtual

Overridden from base class.

Implements sf::ScriptObject.

Reimplemented in sf::ScanMethod, and sf::ScanBinder.

---

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

• ProjectScriptObject.h