SBValueMap

This class exposes bindings for the SAMSON SDK SBValueMap class that describes a value map. This is a convenience class that contains a map from string to samson.SBValue, and can be used, for example, to pass into a function a map of parameters, or another data.

See also

SAMSON SDK: SBCMetaValueMap

Introspection: using extensions

class samson.SBValueMap(*args, **kwargs)

Bases: pybind11_object

This class describes a value map.

This is a convenience class that contains a map from string to SBValue, and can be used, for example, to pass into a function a map of parameters, or another data.

SAMSON API: Introspection, SBCMetaValueMap, SBCMetaValue

Overloaded function.

1. __init__(self: samson.SBValueMap) -> None

Creates an empty map

2. __init__(self: samson.SBValueMap, n: int) -> None

Creates a new map with preallocated size n

3. __init__(self: samson.SBValueMap, valueMap: samson.SBValueMap) -> None

Copy constructor

at(self: samson.SBValueMap, key: str) → samson.SBValue

clear(self: samson.SBValueMap) → None

contains(self: samson.SBValueMap, key: str) → bool

erase(self: samson.SBValueMap, key: str) → bool

get(*args, **kwargs)

Overloaded function.

1. get(self: samson.SBValueMap, key: str) -> samson.SBValue

2. get(self: samson.SBValueMap, key: str, default: object) -> object

insert(self: samson.SBValueMap, key: str, value: samson.SBValue) → bool

items(self: samson.SBValueMap) → list[tuple[str, samson.SBValue]]

keys(self: samson.SBValueMap) → list[str]

pop(self: samson.SBValueMap, key: str, default: object = None) → object

set(self: samson.SBValueMap, key: str, value: samson.SBValue) → None

swap(self: samson.SBValueMap, valueMap: samson.SBValueMap) → None

Swaps maps in O(1)

toDict(self: samson.SBValueMap) → dict[str, samson.SBValue]

Creates a dictionary object from this value map.

update(self: samson.SBValueMap, dict: dict) → None

values(self: samson.SBValueMap) → list[samson.SBValue]