API reference - Class Recipe

Notation used in Ruby API documentation

Module: tl

Description: A facility for providing reproducible recipes

The idea of this facility is to provide a service by which an object can be reproduced in a parametrized way. The intended use case is a DRC report for example, where the DRC script is the generator.

In this use case, the DRC engine will register a recipe. It will put the serialized version of the recipe into the DRC report. If the user requests a re-run of the DRC, the recipe will be called and the implementation is supposed to deliver a new database.

To register a recipe, reimplement the Recipe class and create an instance. To serialize a recipe, use "generator", to execute the recipe, use "make".

Parameters are kept as a generic key/value map.

This class has been introduced in version 0.26.

Public constructors

new Recipe ptrnew(string name,
string description = "")
Creates a new recipe object with the given name and (optional) description

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]stringdescriptionGets the description of the recipe.
[virtual,const]Executable ptrexecutable(map<string,variant> params)Reimplement this method to provide an executable object for the actual implementation.
stringgenerator(map<string,variant> params)Delivers the generator string from the given parameters.
[const]stringnameGets the name of the recipe.

Public static methods and constants

variantmake(string generator,
map<string,variant> add_params = {})
Executes the recipe given by the generator string.

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

description

Signature: [const] string description

Description: Gets the description of the recipe.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

executable

Signature: [virtual,const] Executable ptr executable (map<string,variant> params)

Description: Reimplement this method to provide an executable object for the actual implementation.

The reasoning behind this architecture is to supply a cleanup callback. This is useful when the actual function is executed as a script and the script terminates in the debugger. The cleanup callback allows implementing any kind of post-mortem action despite being cancelled in the debugger.

This method has been introduced in version 0.27 and replaces 'execute'.

generator

Signature: string generator (map<string,variant> params)

Description: Delivers the generator string from the given parameters.

The generator string can be used with make to re-run the recipe.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

make

Signature: [static] variant make (string generator, map<string,variant> add_params = {})

Description: Executes the recipe given by the generator string.

The generator string is the one delivered with generator. Additional parameters can be passed in "add_params". They have lower priority than the parameters kept inside the generator string.

name

Signature: [const] string name

Description: Gets the name of the recipe.

new

Signature: [static] new Recipe ptr new (string name, string description = "")

Description: Creates a new recipe object with the given name and (optional) description

Python specific notes:
This method is the default initializer of the object.