Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::EBusAggregateResults< T > Struct Template Reference

Collects results returned by all handlers of an EBus event. More...

Public Member Functions

AZ_FORCE_INLINE void operator= (const T &rhs)
 Overloads the assignment operator to add a new result to a vector of previous results. More...
 

Public Attributes

AZStd::vector< T > values
 A vector that contains handler results. More...
 

Detailed Description

template<class T>
struct AZ::EBusAggregateResults< T >

Collects results returned by all handlers of an EBus event.

The results are collected into an AZStd::vector.

Template Parameters
TThe return type of the handler.

The following is an example of adding handler results to a vector of previous results:

EBusAggregateResults<int> result;
MyBus::BroadcastResult(result, &MyBus::Events::GetANumber);
for (const int& val : result.values) { ... }

Member Function Documentation

◆ operator=()

template<class T >
AZ_FORCE_INLINE void AZ::EBusAggregateResults< T >::operator= ( const T &  rhs)
inline

Overloads the assignment operator to add a new result to a vector of previous results.

Parameters
rhsA reference to the value that will be added to the vector.

Member Data Documentation

◆ values

template<class T >
AZStd::vector<T> AZ::EBusAggregateResults< T >::values

A vector that contains handler results.


The documentation for this struct was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/EBus/Results.h