#include <RobotAPI/libraries/aron/core/codegeneration/cpp/AronGeneratedObject.h>
Inheritance diagram for AronGeneratedObjectBase:Public Member Functions | |
| AronGeneratedObjectBase ()=default | |
| virtual void | fromAron (const armarx::aron::data::DictPtr &input)=0 |
| Set all members of the current bo according to the aron variant data dict. | |
| virtual void | fromAron (const armarx::aron::data::dto::DictPtr &input)=0 |
| Set all members of the current bo according to the ice representation of an aron variant data dict. | |
| virtual armarx::aron::data::DictPtr | toAron () const =0 |
| Convert the current bo to an aron variant data dict. | |
| virtual armarx::aron::data::dto::DictPtr | toAronDTO () const =0 |
| Convert the current bo to the ice representation of an aron variant data dict. | |
| virtual | ~AronGeneratedObjectBase ()=default |
| Public Member Functions inherited from AronGeneratedClass | |
| AronGeneratedClass ()=default | |
| virtual void | resetHard () |
| Reset all member values of this class to default (as stated in the XML). This may mean that maybe types are null or false and images may be created as headers_only. | |
| virtual void | resetSoft () |
| Reset all member values of this class softly, meaning if a maybe type has a value, we reset only the value (not the full maybe type) and if an image has data (width, height) we keep the data and width and height and only reset teh pixel values. | |
| virtual | ~AronGeneratedClass ()=default |
Constructor & Destructor Documentation
◆ AronGeneratedObjectBase()
|
default |
◆ ~AronGeneratedObjectBase()
|
virtualdefault |
Member Function Documentation
◆ fromAron() [1/2]
|
pure virtual |
Set all members of the current bo according to the aron variant data dict.
◆ fromAron() [2/2]
|
pure virtual |
Set all members of the current bo according to the ice representation of an aron variant data dict.
◆ toAron()
|
pure virtual |
Convert the current bo to an aron variant data dict.
Builds the navigable variant graph (with paths). Use this when the result is navigated, visited or converted (e.g. to JSON), and when committing from inside a memory server (e.g. iceMemory.commitLocking()), since the server stores the variant form anyway.
To send data to a remote memory without inspecting it, prefer toAronDTO().
◆ toAronDTO()
|
pure virtual |
Convert the current bo to the ice representation of an aron variant data dict.
Skips building the variant graph, which saves a dozen or so heap allocations per ARON node. Prefer this in client-side writers that only send data to a memory (update.instancesData = {bo.toAronDTO()} with armem::client::Writer).
Do not use it for commits from inside a memory server: the server rebuilds the variant graph from it, so it would cost more than toAron().
The documentation for this class was generated from the following file:
- RobotAPI/libraries/aron/core/codegeneration/cpp/AronGeneratedObject.h
