ADTF  3.14.3
IScriptableabstract

The IScriptable interface provides a generic way to implement scripting capabilities. More...

Inheritance diagram for IScriptable:
[legend]

Public Types

typedef const char * tScriptArgs
 Standard scripting argument type.
 

Public Member Functions

 ADTF_IID (IScriptable, "scriptable.ant.ucom.adtf.iid")
 Marks the IScriptable to be castable with the ucom_cast<> More...
 
virtual tResult ScriptRunCommand (const char *strCommand, void *pvData=NULL, int szData=0)=0
 Run script command. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~IScriptable ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

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.

Definition at line 26 of file scriptable_intf.h.

Member Function Documentation

◆ ADTF_IID()

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 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.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)