EventAnalysis  1.0.0
Public Member Functions | Public Attributes | Private Attributes | Friends | List of all members
EA::ObjectConsumer::ConsumedObject Struct Reference

Descriptor structure for a consumed object. More...

#include <ObjectConsumer.h>

Public Member Functions

 ConsumedObject ()
 Constructor. More...
 
std::vector< observer_ptr< ConsumedObject > > GetAlternatives () const
 

Public Attributes

std::string name
 
ObjectCategory category
 
std::string store
 
bool optional
 

Private Attributes

observer_ptr< ConsumedObject_prevAlt
 
observer_ptr< ConsumedObject_nextAlt
 

Friends

class ObjectConsumer
 

Detailed Description

Descriptor structure for a consumed object.

This struct groups the properties defining each consumed object.

Constructor & Destructor Documentation

◆ ConsumedObject()

EA::ObjectConsumer::ConsumedObject::ConsumedObject ( )
inline

Constructor.

Parameters
nameThe name of the consumed object.
categoryThe category of the consumed object.
storeThe store from which the consumed object will be fetched.
optionalSet to true for flagging the consumed object as optional.

Member Function Documentation

◆ GetAlternatives()

std::vector< observer_ptr< ObjectConsumer::ConsumedObject > > EA::ObjectConsumer::ConsumedObject::GetAlternatives ( ) const

Get eventual alternative objects.

Returns
A vector of pointers to alternative objects.

Friends And Related Function Documentation

◆ ObjectConsumer

friend class ObjectConsumer
friend

Member Data Documentation

◆ _nextAlt

observer_ptr<ConsumedObject> EA::ObjectConsumer::ConsumedObject::_nextAlt
private

◆ _prevAlt

observer_ptr<ConsumedObject> EA::ObjectConsumer::ConsumedObject::_prevAlt
private

◆ category

ObjectCategory EA::ObjectConsumer::ConsumedObject::category

◆ name

std::string EA::ObjectConsumer::ConsumedObject::name

◆ optional

bool EA::ObjectConsumer::ConsumedObject::optional

◆ store

std::string EA::ObjectConsumer::ConsumedObject::store

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