Builder Class Reference
The query::Builder class provides a fluent-style specification of hierarchical queries. More...
#include <RobotAPI/libraries/armem/client/query/Builder.h>
Inheritance diagram for Builder:Public Member Functions | |
| void | all () |
| Get all snapshots from all entities in all segments. | |
| void | allEntitySnapshots (const MemoryID &entityID) |
| void | allInCoreSegment (const MemoryID &coreSegmentID) |
| Get all snapshots from all entities in all provider segments in a core segment. | |
| void | allInProviderSegment (const MemoryID &providerSegmentID) |
| Get all snapshots from all entities in a provider segment. | |
| void | allLatest () |
| Get all latest snapshots from entities in all segments. | |
| void | allLatestInCoreSegment (const MemoryID &coreSegmentID) |
| Get latest snapshots from all entities in all provider segments in a core segment. | |
| void | allLatestInProviderSegment (const MemoryID &providerSegmentID) |
| Get latest snapshots from all entities in a provider segment. | |
| Builder (armem::query::DataMode dataMode=armem::query::DataMode::WithData, armem::query::QueryTarget target=armem::query::QueryTarget::WM) | |
| armem::query::data::MemoryQuerySeq | buildMemoryQueries () const |
| QueryInput | buildQueryInput () const |
| armem::query::data::Input | buildQueryInputIce () const |
| CoreSegmentSelector & | coreSegments () |
| Start specifying core segments. | |
| CoreSegmentSelector & | coreSegments (const CoreSegmentSelector &selector) |
| template<class... Ts> | |
| CoreSegmentSelector & | coreSegments (Ts... args) |
| void | latestEntitySnapshot (const MemoryID &entityID) |
| void | multipleEntitySnapshots (const std::vector< MemoryID > &snapshotIDs) |
| void | singleEntitySnapshot (const MemoryID &snapshotID) |
| Public Member Functions inherited from ParentSelectorOps< Builder, CoreSegmentSelector > | |
| virtual | ~ParentSelectorOps ()=default |
Public Attributes | |
| armem::query::DataMode | dataMode |
| armem::query::QueryTarget | queryTarget |
Additional Inherited Members | |
| Public Types inherited from ParentSelectorOps< Builder, CoreSegmentSelector > | |
| using | ChildT |
| using | DerivedT |
| Protected Member Functions inherited from ParentSelectorOps< Builder, CoreSegmentSelector > | |
| ChildT & | _addChild () |
| ChildT & | _addChild (const ChildT &child) |
| ChildT & | _addChild (Ts... args) |
| Protected Attributes inherited from ParentSelectorOps< Builder, CoreSegmentSelector > | |
| std::vector< ChildT > | _children |
Detailed Description
The query::Builder class provides a fluent-style specification of hierarchical queries.
Syntax:
TODO
Constructor & Destructor Documentation
◆ Builder()
| Builder | ( | armem::query::DataMode | dataMode = armem::query::DataMode::WithData, |
| armem::query::QueryTarget | target = armem::query::QueryTarget::WM ) |
Member Function Documentation
◆ all()
| void all | ( | ) |
Get all snapshots from all entities in all segments.
◆ allEntitySnapshots()
| void allEntitySnapshots | ( | const MemoryID & | entityID | ) |
◆ allInCoreSegment()
| void allInCoreSegment | ( | const MemoryID & | coreSegmentID | ) |
Get all snapshots from all entities in all provider segments in a core segment.
◆ allInProviderSegment()
| void allInProviderSegment | ( | const MemoryID & | providerSegmentID | ) |
Get all snapshots from all entities in a provider segment.
◆ allLatest()
| void allLatest | ( | ) |
Get all latest snapshots from entities in all segments.
◆ allLatestInCoreSegment()
| void allLatestInCoreSegment | ( | const MemoryID & | coreSegmentID | ) |
Get latest snapshots from all entities in all provider segments in a core segment.
◆ allLatestInProviderSegment()
| void allLatestInProviderSegment | ( | const MemoryID & | providerSegmentID | ) |
Get latest snapshots from all entities in a provider segment.
◆ buildMemoryQueries()
| armem::query::data::MemoryQuerySeq buildMemoryQueries | ( | ) | const |
◆ buildQueryInput()
| QueryInput buildQueryInput | ( | ) | const |
◆ buildQueryInputIce()
| armem::query::data::Input buildQueryInputIce | ( | ) | const |
◆ coreSegments() [1/3]
| CoreSegmentSelector & coreSegments | ( | ) |
Start specifying core segments.
◆ coreSegments() [2/3]
| CoreSegmentSelector & coreSegments | ( | const CoreSegmentSelector & | selector | ) |
◆ coreSegments() [3/3]
template<class... Ts>
|
inline |
◆ latestEntitySnapshot()
| void latestEntitySnapshot | ( | const MemoryID & | entityID | ) |
◆ multipleEntitySnapshots()
| void multipleEntitySnapshots | ( | const std::vector< MemoryID > & | snapshotIDs | ) |
◆ singleEntitySnapshot()
| void singleEntitySnapshot | ( | const MemoryID & | snapshotID | ) |
Member Data Documentation
◆ dataMode
| armem::query::DataMode dataMode |
◆ queryTarget
| armem::query::QueryTarget queryTarget |
The documentation for this class was generated from the following files:
- RobotAPI/libraries/armem/client/query/Builder.h
- RobotAPI/libraries/armem/client/query/Builder.cpp
