Class In::Filter

Nested Relationships

This class is a nested type of Class MsgBucket::In.

Class Documentation

class MsgBucket::In::Filter

This class is created when a search origin is provided to MsgBucket::In::operator()(IntT) It provides iterator access to the subset of messages found within the specified bucket



Public Functions

__device__ inline Filter(const MetaData *_metadata, const Curve::NamespaceHash &combined_hash, const IntT &beginKey, const IntT &endKey)

Constructor, takes the search parameters required Begin key and end key specify the [begin, end) contiguous range of bucket. (inclusive begin, exclusive end)

  • _metadata – Pointer to message list metadata

  • combined_hash – agentfn+message hash for accessing message data

  • beginKey – Inclusive first bucket of range to access

  • endKey – Exclusive final bucket of range to access, this is the final bucket + 1

__device__ inline iterator begin(void) const

Returns an iterator to the start of the message list subset about the search origin

__device__ inline iterator end(void) const

Returns an iterator to the position beyond the end of the message list subset


This iterator is the same for all message list subsets

__device__ inline unsigned int size(void) const

Returns the number of messages in the filtered bucket

class iterator

Stock iterator for iterating MsgBucket::In::Filter::Message objects

Public Functions

__device__ inline iterator(const Filter &parent, const unsigned int &cell_index)

Constructor This iterator is constructed by MsgBucket::In::Filter::begin()(IntT)



__device__ inline iterator &operator++()

Moves to the next message (Prefix increment operator)

__device__ inline iterator operator++(int)

Moves to the next message (Postfix increment operator, returns value prior to increment)

__device__ inline bool operator==(const iterator &rhs) const

Equality operator Compares message

__device__ inline bool operator!=(const iterator &rhs) const

Inequality operator Compares message

__device__ inline Message &operator*()

Dereferences the iterator to return the message object, for accessing variables

__device__ inline Message *operator->()

Dereferences the iterator to return the message object, for accessing variables

class Message

Provides access to a specific message Returned by the iterator



Public Functions

__device__ inline Message(const Filter &parent, const unsigned int &_cell_index)

Constructs a message and directly initialises all of it’s member variables


See member variable documentation for their purposes

__device__ inline bool operator==(const Message &rhs) const

Equality operator Compares all internal member vars for equality


Does not compare _parent

__device__ inline bool operator!=(const Message &rhs) const

Inequality operator Returns inverse of equality operator


operator==(const Message&)

__device__ inline Message &operator++()

Updates the message to return variables from the next message in the message list


Returns itself

template<typename T, size_type N>
__device__ T getVariable(const char (&variable_name)[N]) const

Returns the value for the current message attached to the named variable


variable_name – Name of the variable

Template Parameters
  • T – type of the variable

  • N – Length of variable name (this should be implicit if a string literal is passed to variable name)


The specified variable, else 0x0 if an error occurs