adtf::ucom::ant::IScriptable Class Reference

#include <scriptable_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Types
typedef const char *	tScriptArgs
	Standard scripting argument type.

Public Member Functions
	ADTF_IID (IScriptable, "scriptable.ant.ucom.adtf.iid")
virtual tResult	ScriptRunCommand (const char *strCommand, void *pvData=NULL, int szData=0)=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IScriptable ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

The IScriptable interface provides a generic way to implement scripting capabilities. Script calls are encapsulated in simple XML strings that contain command and parameter information. Parameter passing is usually done by using XML attributes and name-value pairs, but it is up to the implementer to declare any advanced mechanism on top of XML to be used for communication.

Member Function Documentation

ADTF_IID()

adtf::ucom::ant::IScriptable::ADTF_IID	(	IScriptable	,
		"scriptable.ant.ucom.adtf.iid"	)

Marks the IScriptable to be castable with the ucom_cast<>

See also

ADTF_IID(_interface, _striid)

ScriptRunCommand()

virtual tResult adtf::ucom::ant::IScriptable::ScriptRunCommand ( const char * strCommand, void * pvData = NULL, int szData = 0 )

pure virtual

Run script command. The ScriptRunCommand method calls a specific script command.

Parameters

strCommand

[in] XML command string. The command string has the following body: < cmd name="CMD" / > you can use e.g. the macro

See also

__script_cmd0

Parameters

pvData	[in] Pointer to command specific data.
szData	[in] Size of command specific data.

Returns

Returns a standard result code.

---

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

• src/libraries/ucom3/include/adtfucom3/interfaces/scriptable_intf.h