DotMP
Package Functions | Static Private Attributes | List of all members
DotMP.SectionsContainer Class Reference

Static class that contains necessary information for sections. Sections allow for the user to submit multiple actions to be executed in parallel. A sections region contains a collection of actions to be executed, specified as Parallel.Section directives. More information can be found in the Parallel.Sections documentation. More...

Package Functions

Action GetNextItem (out bool successful)
 Gets the next item from the actions bag. More...
 
 SectionsContainer (IEnumerable< Action > actions)
 Constructor which takes a list of actions and ensures the master thread assigns to SectionsContainer.actions_pv. More...
 

Static Private Attributes

static ConcurrentBag< Action > actions_pv
 The actions submitted by the individual section directives. More...
 

Detailed Description

Static class that contains necessary information for sections. Sections allow for the user to submit multiple actions to be executed in parallel. A sections region contains a collection of actions to be executed, specified as Parallel.Section directives. More information can be found in the Parallel.Sections documentation.

Constructor & Destructor Documentation

◆ SectionsContainer()

DotMP.SectionsContainer.SectionsContainer ( IEnumerable< Action >  actions)
package

Constructor which takes a list of actions and ensures the master thread assigns to SectionsContainer.actions_pv.

Parameters
actionsThe actions that the Parallel.Sections region will perform.

Member Function Documentation

◆ GetNextItem()

Action DotMP.SectionsContainer.GetNextItem ( out bool  successful)
inlinepackage

Gets the next item from the actions bag.

Parameters
successfulWhether or not fetching from the bag was successful.
Returns
The action pulled from the bag, if successful. If unsuccessful, undefined.

Member Data Documentation

◆ actions_pv

ConcurrentBag<Action> DotMP.SectionsContainer.actions_pv
staticprivate

The actions submitted by the individual section directives.


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