Base class

class BehaviorModulation

This class describes a generic behavior modulation that happens right before (pre()) and right after (post()) computing a command.

__init__() → None

dump(Modulation) → str

Dumps the object to a YAML-string.

Returns:

The YAML representation

Return type:

str

get(name: str) → bool | int | float | str | Vector2 | list[bool] | list[int] | list[float] | list[str] | list[Vector2]

Gets the value of the specified property.

Parameters:

name – The name of the property

Raise:

std::runtime_error A runtime error if no property is found.

Returns:

The value of the property

get_property_type_name(name: str) → str

Gets the type of a property.

Parameters:

name – The name of the property

Returns:

The property type name or an empty string if the property is not defined.

has(name: str) → bool

Checks whether a property exists.

Parameters:

name – The name of the property

Returns:

True if the property exists

static has_type(name: str) → bool

Check whether a type name has been registered.

Parameters:

type – The associated type name.

Returns:

True if the type name has been registered.

static load(value: str) → object

Load a modulation from a YAML string.

Parameters:

value – the YAML string.

Returns:

The loaded modulation or None if loading fails.

Return type:

BehaviorModulation| None

static make_type(name: str) → object

Create an object of a sub-class selected by name.

Parameters:

type – The associated type name.

Returns:

An object of a registered sub-class or None in case the desired name is not found.

post(behavior: navground.core.Behavior, time_step: float, cmd: navground.core.Twist2) → navground.core.Twist2

Called right after the evaluation of behavior in Behavior.compute_cmd().

Parameters:

• behavior – The behavior being evaluated

• time_step – The time step

• cmd – The command just computed by the behavior

pre(behavior: navground.core.Behavior, time_step: float) → None

Called right before the evaluation of behavior in Behavior.compute_cmd().

Parameters:

• behavior – The behavior being evaluated

• time_step – The time step

static register_schema() → object

Returns the json-schema that includes registered components.

Returns:

“anyOf” json-schema of all registered components.

Return type:

dict[str, typing.Any]

static schema(reference_register_schema: bool = True, type: str | None = None) → object

Returns the json-schema of a component

Returns an empty dictionary if a not registered type is requested.

Parameters:

• reference_register_schema – Whether to reference registered components schema in the base class schema.

• type (str) – An optional registered type. If not specified, it returns the schema of the base class.

Returns:

A json-schema of the registered class

Return type:

dict[str, typing.Any]

set(name: str, value: bool | int | float | str | Vector2 | list[bool] | list[int] | list[float] | list[str] | list[Vector2]) → None

Set the value of a named property. Fails silently if no property can be found or if the value has a non-compatible type.

Parameters:

• name – The name of the property

• value – The desired value for the property

property enabled

Type:

bool

Returns whether the modulation is enabled

property properties

Type:

dict[str, navground.core.Property]

The registered properties

property type

Type:

str

The name associated to the type of an object