Mercury Messaging
Documentation for the Mercury Messaging Framework
MercuryMessaging.Task.MmRepeatingTask< T > Class Template Reference

This class is useful for creating MmTaskInfos that keep repeating but would not iterate through the a MmTaskInfo collection. More...

Public Member Functions

 MmRepeatingTask ()
 Create empty MmRepeatingTask More...
 
 MmRepeatingTask (List< string > labels)
 Create MmRepeatingTask with provided labels. More...
 
void IterateRepeatingTask ()
 Iterate through the names in the FreeModeNames. More...
 

Public Attributes

List< string > FreeModeNames
 MmRepeatingTasks will iterate through a list of names. The active name will be stored in Task More...
 
bool ShuffleLabels = true
 If active, this object will shuffle the provided FreeModeNames. More...
 
int FreeModeVizRepeats = 3
 The number of repetitions given to a particular name, before the next name in the FreeModeNames list is selected. More...
 
int FreeModeVizRepeatIndex = 0
 Counter for iterating through reptitions. More...
 
Task
 The particular task that is being reused. You can take a task from a file, or create a new one, store it here, and simply replace the name stored in the task to change its behavior as the MmRepeatingTask iterates. More...
 

Protected Attributes

int FreeModeIndex
 The name of the active FreeModeNames will be at this index. More...
 

Detailed Description

This class is useful for creating MmTaskInfos that keep repeating but would not iterate through the a MmTaskInfo collection.

Template Parameters
TSpecific type of MmTaskInfo to use in this repeating task.
Type Constraints
T :MmTaskInfo 
T :new() 

Constructor & Destructor Documentation

◆ MmRepeatingTask() [1/2]

◆ MmRepeatingTask() [2/2]

MercuryMessaging.Task.MmRepeatingTask< T >.MmRepeatingTask ( List< string >  labels)

Create MmRepeatingTask with provided labels.

Parameters
labelsA list of the names of MmResponders to use for this repeating task.

Member Function Documentation

◆ IterateRepeatingTask()

void MercuryMessaging.Task.MmRepeatingTask< T >.IterateRepeatingTask ( )

Iterate through the names in the FreeModeNames.

Member Data Documentation

◆ FreeModeIndex

int MercuryMessaging.Task.MmRepeatingTask< T >.FreeModeIndex
protected

The name of the active FreeModeNames will be at this index.

◆ FreeModeNames

List<string> MercuryMessaging.Task.MmRepeatingTask< T >.FreeModeNames

MmRepeatingTasks will iterate through a list of names. The active name will be stored in Task

◆ FreeModeVizRepeatIndex

int MercuryMessaging.Task.MmRepeatingTask< T >.FreeModeVizRepeatIndex = 0

Counter for iterating through reptitions.

◆ FreeModeVizRepeats

int MercuryMessaging.Task.MmRepeatingTask< T >.FreeModeVizRepeats = 3

The number of repetitions given to a particular name, before the next name in the FreeModeNames list is selected.

◆ ShuffleLabels

bool MercuryMessaging.Task.MmRepeatingTask< T >.ShuffleLabels = true

If active, this object will shuffle the provided FreeModeNames.

◆ Task

The particular task that is being reused. You can take a task from a file, or create a new one, store it here, and simply replace the name stored in the task to change its behavior as the MmRepeatingTask iterates.


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