C++  1.4.6
CloudBackend Software Development Kit - SDK API for C++
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CBE::QueryResult Class Reference
Collaboration diagram for CBE::QueryResult:
Collaboration graph
[legend]

Public Member Functions

virtual CBE::Filter filter () const
 
virtual std::vector< CBE::ItemPtr > getItemsSnapshot ()
 
virtual uint64_t itemsLoaded ()
 
virtual uint64_t totalCount ()
 
virtual uint64_t objectsLoaded ()
 
virtual uint64_t containersLoaded ()
 
bool containsItem (uint64_t itemId)
 

Protected Member Functions

void initItems ()
 

Protected Attributes

std::vector< CBE::ItemPtr > items
 
uint64_t _totalCount
 
std::vector< std::pair< uint64_t, uint64_t > > _loadedPages
 

Friends

class DirectoryCache
 
class CloudBackend
 

Member Function Documentation

◆ filter()

virtual CBE::Filter CBE::QueryResult::filter ( ) const
virtual

Filter can be used to see what has been loaded.

Returns a copy of the filter used for query.

◆ getItemsSnapshot()

virtual std::vector<CBE::ItemPtr> CBE::QueryResult::getItemsSnapshot ( )
virtual

Returns a copy of a vector containing the items for the queryResult.
The queryResult will update when new data comes in but the copy will not. If iterating make sure to create a variable for a local copy.

Returns
vector<CBE::ItemPtr> contains the items matching the query.

◆ objectsLoaded()

virtual uint64_t CBE::QueryResult::objectsLoaded ( )
virtual

Returns # of objects loaded in to the query result.

◆ containersLoaded()

virtual uint64_t CBE::QueryResult::containersLoaded ( )
virtual

Returns " of containers loaded in to the query result.

◆ containsItem()

bool CBE::QueryResult::containsItem ( uint64_t  itemId)

Checks if the Item with id

Parameters
itemId,isin the query result.

◆ initItems()

void CBE::QueryResult::initItems ( )
protected

Resizes the items vector to fit the total count of items.

Member Data Documentation

◆ items

std::vector<CBE::ItemPtr> CBE::QueryResult::items
protected

Vector with all Items loaded from the query.

◆ _totalCount

uint64_t CBE::QueryResult::_totalCount
protected

The number of items on the cloud.


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