FOUND
Loading...
Searching...
No Matches
found::ModifyingStage< T > Class Template Reference

ModifyingStage is a stage that modifies a resource. More...

#include <stages.hpp>

Inheritance diagram for found::ModifyingStage< T >:
Collaboration diagram for found::ModifyingStage< T >:

Public Member Functions

 ModifyingStage ()=default
 Constructs a new ModifyingStage.
 
virtual ~ModifyingStage ()=default
 Destroys this.
 
void DoAction () override
 Executes Run (with void return)
 
void SetResource (T &resource)
 Sets the resource to modify.
 
- Public Member Functions inherited from found::Stage< raw_type< T > &, void >
virtual void Run (raw_type< T > & input)=0
 Runs this stage.
 

Private Attributes

T * resource = nullptr
 The pointer to the resource.
 

Detailed Description

template<typename T>
class found::ModifyingStage< T >

ModifyingStage is a stage that modifies a resource.

Parameters
TThe type of resource being modified

Member Function Documentation

◆ DoAction()

template<typename T >
void found::ModifyingStage< T >::DoAction ( )
inlineoverridevirtual

Executes Run (with void return)

Implements found::Action.

◆ SetResource()

template<typename T >
void found::ModifyingStage< T >::SetResource ( T &  resource)
inline

Sets the resource to modify.

Parameters
resourceThe resource to modify
Postcondition
When used in a ModifyingPipeline, this will modify resource via Run(T &)

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