# {py:mod}`ros_sugar.robot.mapping`

```{py:module} ros_sugar.robot.mapping
```

```{autodoc2-docstring} ros_sugar.robot.mapping
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`VendorMapping <ros_sugar.robot.mapping.VendorMapping>`
  - ```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping
    :summary:
    ```
* - {py:obj}`NativeMapping <ros_sugar.robot.mapping.NativeMapping>`
  - ```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping
    :summary:
    ```
````

### API

`````{py:class} VendorMapping
:canonical: ros_sugar.robot.mapping.VendorMapping

Bases: {py:obj}`ros_sugar.config.BaseAttrs`

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping
```

````{py:method} active_grid_path() -> typing.Optional[str]
:canonical: ros_sugar.robot.mapping.VendorMapping.active_grid_path

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.active_grid_path
```

````

````{py:property} kind
:canonical: ros_sugar.robot.mapping.VendorMapping.kind
:type: str

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.kind
```

````

````{py:method} spec() -> typing.Dict[str, typing.Any]
:canonical: ros_sugar.robot.mapping.VendorMapping.spec

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.spec
```

````

````{py:method} asdict(filter: typing.Optional[typing.Callable] = None) -> typing.Dict
:canonical: ros_sugar.robot.mapping.VendorMapping.asdict

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.asdict
```

````

````{py:method} to_dict() -> typing.Dict
:canonical: ros_sugar.robot.mapping.VendorMapping.to_dict

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.to_dict
```

````

````{py:method} asdict_explicit() -> typing.Dict
:canonical: ros_sugar.robot.mapping.VendorMapping.asdict_explicit

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.asdict_explicit
```

````

````{py:method} from_dict(dict_obj: typing.Dict) -> None
:canonical: ros_sugar.robot.mapping.VendorMapping.from_dict

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.from_dict
```

````

````{py:method} from_file(file_path: str, nested_root_name: typing.Union[str, None] = None, get_common: bool = False) -> bool
:canonical: ros_sugar.robot.mapping.VendorMapping.from_file

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.from_file
```

````

````{py:method} to_json() -> typing.Union[str, bytes, bytearray]
:canonical: ros_sugar.robot.mapping.VendorMapping.to_json

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.to_json
```

````

````{py:method} from_json(json_obj: typing.Union[str, bytes, bytearray]) -> None
:canonical: ros_sugar.robot.mapping.VendorMapping.from_json

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.from_json
```

````

````{py:method} has_attribute(attr_name: str) -> bool
:canonical: ros_sugar.robot.mapping.VendorMapping.has_attribute

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.has_attribute
```

````

````{py:method} get_attribute_type(attr_name: str) -> typing.Optional[type]
:canonical: ros_sugar.robot.mapping.VendorMapping.get_attribute_type

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.get_attribute_type
```

````

````{py:method} update_value(attr_name: str, attr_value: typing.Any) -> bool
:canonical: ros_sugar.robot.mapping.VendorMapping.update_value

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.update_value
```

````

````{py:method} get_fields_info(class_object) -> typing.Dict[str, typing.Dict[str, typing.Any]]
:canonical: ros_sugar.robot.mapping.VendorMapping.get_fields_info
:classmethod:

```{autodoc2-docstring} ros_sugar.robot.mapping.VendorMapping.get_fields_info
```

````

`````

`````{py:class} NativeMapping
:canonical: ros_sugar.robot.mapping.NativeMapping

Bases: {py:obj}`ros_sugar.config.BaseAttrs`

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping
```

````{py:method} active_grid_path() -> typing.Optional[str]
:canonical: ros_sugar.robot.mapping.NativeMapping.active_grid_path

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.active_grid_path
```

````

````{py:property} kind
:canonical: ros_sugar.robot.mapping.NativeMapping.kind
:type: str

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.kind
```

````

````{py:method} spec() -> typing.Dict[str, typing.Any]
:canonical: ros_sugar.robot.mapping.NativeMapping.spec

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.spec
```

````

````{py:method} asdict(filter: typing.Optional[typing.Callable] = None) -> typing.Dict
:canonical: ros_sugar.robot.mapping.NativeMapping.asdict

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.asdict
```

````

````{py:method} to_dict() -> typing.Dict
:canonical: ros_sugar.robot.mapping.NativeMapping.to_dict

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.to_dict
```

````

````{py:method} asdict_explicit() -> typing.Dict
:canonical: ros_sugar.robot.mapping.NativeMapping.asdict_explicit

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.asdict_explicit
```

````

````{py:method} from_dict(dict_obj: typing.Dict) -> None
:canonical: ros_sugar.robot.mapping.NativeMapping.from_dict

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.from_dict
```

````

````{py:method} from_file(file_path: str, nested_root_name: typing.Union[str, None] = None, get_common: bool = False) -> bool
:canonical: ros_sugar.robot.mapping.NativeMapping.from_file

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.from_file
```

````

````{py:method} to_json() -> typing.Union[str, bytes, bytearray]
:canonical: ros_sugar.robot.mapping.NativeMapping.to_json

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.to_json
```

````

````{py:method} from_json(json_obj: typing.Union[str, bytes, bytearray]) -> None
:canonical: ros_sugar.robot.mapping.NativeMapping.from_json

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.from_json
```

````

````{py:method} has_attribute(attr_name: str) -> bool
:canonical: ros_sugar.robot.mapping.NativeMapping.has_attribute

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.has_attribute
```

````

````{py:method} get_attribute_type(attr_name: str) -> typing.Optional[type]
:canonical: ros_sugar.robot.mapping.NativeMapping.get_attribute_type

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.get_attribute_type
```

````

````{py:method} update_value(attr_name: str, attr_value: typing.Any) -> bool
:canonical: ros_sugar.robot.mapping.NativeMapping.update_value

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.update_value
```

````

````{py:method} get_fields_info(class_object) -> typing.Dict[str, typing.Dict[str, typing.Any]]
:canonical: ros_sugar.robot.mapping.NativeMapping.get_fields_info
:classmethod:

```{autodoc2-docstring} ros_sugar.robot.mapping.NativeMapping.get_fields_info
```

````

`````