CnC
 All Classes Namespaces Functions Variables Typedefs Enumerator Friends Groups Pages
Public Types | Public Member Functions
step_collection< UserStep, Tuner > Class Template Reference

A step collection is logical set of step instances. More...

List of all members.

Public Types

typedef UserStep step_type
 the type of the step as provided by the user
typedef Tuner tuner_type
 the type of the tuner as provided by the user

Public Member Functions

template<typename Derived >
 step_collection (context< Derived > &ctxt, const std::string &name, const step_type &userStep, const tuner_type &tnr)
 constructor which registers collection with given context
template<typename DataTag , typename Item , typename ITuner >
void consumes (CnC::item_collection< DataTag, Item, ITuner > &)
 Declare this step-collecation as consumer of given item-collection.
template<typename DataTag , typename Item , typename ITuner >
void produces (CnC::item_collection< DataTag, Item, ITuner > &)
 Declare this step-collecation as producer for given item-collection.
template<typename ControlTag , typename TTuner >
void controls (CnC::tag_collection< ControlTag, TTuner > &)
 Declare this step-collecation as controller of given tag-collection.

Detailed Description

template<typename UserStep, typename Tuner = step_tuner<>>
class CnC::step_collection< UserStep, Tuner >

A step collection is logical set of step instances.

A step-collection must be prescribed by a tag-collection and it can be part of consumer/producer relationships with item-collections. Additionally, it can be the controller in control-dependencies (e.g. produce tags).

Definition at line 57 of file cnc.h.


Constructor & Destructor Documentation

step_collection ( context< Derived > &  ctxt,
const std::string &  name,
const step_type userStep,
const tuner_type tnr 
)

constructor which registers collection with given context

Parameters:
ctxtthe context this collection belongs to
namean optional name, used for debug output and tracing
userStepan optional user step argument, a copy will be created through copy-construction
tnran optional tuner object which must persist throughout the lifetime of the step-collection by default a default-constructed tuner will be used.

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