List of all members | Public Member Functions | Public Attributes
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. More...
 
void allEntitySnapshots (const MemoryID &entityID)
 
void allInCoreSegment (const MemoryID &coreSegmentID)
 Get all snapshots from all entities in all provider segments in a core segment. More...
 
void allInProviderSegment (const MemoryID &providerSegmentID)
 Get all snapshots from all entities in a provider segment. More...
 
void allLatest ()
 Get all latest snapshots from entities in all segments. More...
 
void allLatestInCoreSegment (const MemoryID &coreSegmentID)
 Get latest snapshots from all entities in all provider segments in a core segment. More...
 
void allLatestInProviderSegment (const MemoryID &providerSegmentID)
 Get latest snapshots from all entities in a provider segment. More...
 
 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. More...
 
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 = CoreSegmentSelector
 
using DerivedT = Builder
 
- 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

Definition at line 22 of file Builder.h.

Constructor & Destructor Documentation

◆ Builder()

Builder ( armem::query::DataMode  dataMode = armem::query::DataMode::WithData,
armem::query::QueryTarget  target = armem::query::QueryTarget::WM 
)

Definition at line 7 of file Builder.cpp.

Member Function Documentation

◆ all()

void all ( )

Get all snapshots from all entities in all segments.

Definition at line 49 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ allEntitySnapshots()

void allEntitySnapshots ( const MemoryID &  entityID)

Definition at line 99 of file Builder.cpp.

+ Here is the call graph for this function:

◆ allInCoreSegment()

void allInCoreSegment ( const MemoryID &  coreSegmentID)

Get all snapshots from all entities in all provider segments in a core segment.

Definition at line 67 of file Builder.cpp.

+ Here is the call graph for this function:

◆ allInProviderSegment()

void allInProviderSegment ( const MemoryID &  providerSegmentID)

Get all snapshots from all entities in a provider segment.

Definition at line 83 of file Builder.cpp.

+ Here is the call graph for this function:

◆ allLatest()

void allLatest ( )

Get all latest snapshots from entities in all segments.

Definition at line 58 of file Builder.cpp.

+ Here is the call graph for this function:

◆ allLatestInCoreSegment()

void allLatestInCoreSegment ( const MemoryID &  coreSegmentID)

Get latest snapshots from all entities in all provider segments in a core segment.

Definition at line 75 of file Builder.cpp.

+ Here is the call graph for this function:

◆ allLatestInProviderSegment()

void allLatestInProviderSegment ( const MemoryID &  providerSegmentID)

Get latest snapshots from all entities in a provider segment.

Definition at line 91 of file Builder.cpp.

+ Here is the call graph for this function:

◆ buildMemoryQueries()

armem::query::data::MemoryQuerySeq buildMemoryQueries ( ) const

Definition at line 23 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildQueryInput()

QueryInput buildQueryInput ( ) const

Definition at line 11 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildQueryInputIce()

armem::query::data::Input buildQueryInputIce ( ) const

Definition at line 18 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coreSegments() [1/3]

CoreSegmentSelector & coreSegments ( )

Start specifying core segments.

Definition at line 38 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coreSegments() [2/3]

CoreSegmentSelector & coreSegments ( const CoreSegmentSelector &  selector)

Definition at line 43 of file Builder.cpp.

+ Here is the call graph for this function:

◆ coreSegments() [3/3]

CoreSegmentSelector& coreSegments ( Ts...  args)
inline

Definition at line 34 of file Builder.h.

+ Here is the call graph for this function:

◆ latestEntitySnapshot()

void latestEntitySnapshot ( const MemoryID &  entityID)

Definition at line 107 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ multipleEntitySnapshots()

void multipleEntitySnapshots ( const std::vector< MemoryID > &  snapshotIDs)

Definition at line 123 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ singleEntitySnapshot()

void singleEntitySnapshot ( const MemoryID &  snapshotID)

Definition at line 115 of file Builder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ dataMode

armem::query::DataMode dataMode

Definition at line 71 of file Builder.h.

◆ queryTarget

armem::query::QueryTarget queryTarget

Definition at line 72 of file Builder.h.

The documentation for this class was generated from the following files: