Abstract class representing virtual script data. More...

#include <ugdk/script/virtualdata.h>

Inheritance diagram for ugdk::script::VirtualData:

Collaboration diagram for ugdk::script::VirtualData:

Public Types
typedef std::shared_ptr < VirtualData >	Ptr

typedef std::shared_ptr< const VirtualData >	ConstPtr

typedef std::weak_ptr < VirtualData >	WeakPtr

typedef std::vector< Ptr >	Vector

typedef std::list< Ptr >	List

typedef std::map< Ptr, Ptr >	Map

Public Member Functions
virtual	~VirtualData ()

Ptr	Copy ()

virtual void *	Unwrap (const VirtualType &type, bool disown) const =0
	Tries to unwrap the data contained in this object using the given type. More...

virtual const char *	UnwrapString () const =0

virtual bool	UnwrapBoolean () const =0

virtual int	UnwrapInteger () const =0

virtual double	UnwrapNumber () const =0

virtual Vector	UnwrapVector () const =0

virtual List	UnwrapList () const =0

virtual Map	UnwrapMap () const =0

virtual void	Wrap (void *data, const VirtualType &type, bool disown)=0
	Tries to wrap the given data with the given type. More...

virtual void	WrapString (const char *str)=0

virtual void	WrapBoolean (bool boolean)=0

virtual void	WrapInteger (int number)=0

virtual void	WrapNumber (double number)=0

virtual LangWrapper *	wrapper () const =0

virtual Ptr	Execute (const Vector &args)=0

virtual Ptr	GetAttribute (Ptr key)=0
	Tries to get a attribute with the given name from this object. More...

virtual Ptr	SetAttribute (Ptr key, Ptr value)=0

virtual void *	unsafe_data () const =0

virtual void	AddToBuffer ()

virtual void	RemoveFromBuffer ()

Protected Member Functions
	VirtualData ()

Detailed Description

Abstract class representing virtual script data.

Member Typedef Documentation

typedef std::shared_ptr<const VirtualData> ugdk::script::VirtualData::ConstPtr

typedef std::list<Ptr> ugdk::script::VirtualData::List

typedef std::map<Ptr, Ptr> ugdk::script::VirtualData::Map

typedef std::shared_ptr<VirtualData> ugdk::script::VirtualData::Ptr

typedef std::vector<Ptr> ugdk::script::VirtualData::Vector

typedef std::weak_ptr<VirtualData> ugdk::script::VirtualData::WeakPtr

Constructor & Destructor Documentation

virtual ugdk::script::VirtualData::~VirtualData ( )

inlinevirtual

ugdk::script::VirtualData::VirtualData ( )

inlineprotected

Member Function Documentation

virtual void ugdk::script::VirtualData::AddToBuffer ( )

inlinevirtual

Reimplemented in ugdk::script::lua::LuaData.

Ptr ugdk::script::VirtualData::Copy ( )

inline

virtual Ptr ugdk::script::VirtualData::Execute ( const Vector & args )

pure virtual

Tries to execute ourselves as a function in a script language, passing the given arguments and returning the result.

virtual Ptr ugdk::script::VirtualData::GetAttribute ( Ptr key )

pure virtual

Tries to get a attribute with the given name from this object.

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual void ugdk::script::VirtualData::RemoveFromBuffer ( )

inlinevirtual

Reimplemented in ugdk::script::lua::LuaData.

virtual Ptr ugdk::script::VirtualData::SetAttribute	(	Ptr	key,
		Ptr	value
	)

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual void* ugdk::script::VirtualData::unsafe_data ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual void* ugdk::script::VirtualData::Unwrap	(	const VirtualType &	type,
		bool	disown
	)		const

pure virtual

Tries to unwrap the data contained in this object using the given type.

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual bool ugdk::script::VirtualData::UnwrapBoolean ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual int ugdk::script::VirtualData::UnwrapInteger ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual List ugdk::script::VirtualData::UnwrapList ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual Map ugdk::script::VirtualData::UnwrapMap ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual double ugdk::script::VirtualData::UnwrapNumber ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual const char* ugdk::script::VirtualData::UnwrapString ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual Vector ugdk::script::VirtualData::UnwrapVector ( ) const

pure virtual

Implemented in ugdk::script::python::PythonData, and ugdk::script::lua::LuaData.

virtual void ugdk::script::VirtualData::Wrap	(	void *	data,
		const VirtualType &	type,
		bool	disown
	)

pure virtual

Tries to wrap the given data with the given type.

Returns a new VirtualData::Ptr with the data wrapped upon success.

The VirtualData object returned by this method is NOT NECESSARILY the same as the one that called it. Thus a safe way to use this is like this:

VirtualData::Ptr vdata; // ... vdata = vdata->Wrap(...);

Parameters

data	- a void pointer to the data being wrapped.
type	- a virtual type got from TypeRegistry<T>::type(), where T is the original declarated type of the data.