ActivityDef (EngineBlock API)

java.lang.Object
- io.engineblock.activityimpl.ActivityDef

```
public class ActivityDef
extends Object
```
A runtime definition for an activity.

Instances of ActivityDef hold control values for the execution of a single activity. Each thread of the related activity is initialized with the associated ActivityDef. When the ActivityDef is modified, interested activity threads are notified so that they can dynamically adjust.

The canonical values for all parameters are kept internally in the parameter map. Essentially, ActivityDef is just a type-aware wrapper around a thread-safe parameter map, with an atomic change counter which can be used to signal changes to observers.

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_ALIAS

static String DEFAULT_ATYPE

static String DEFAULT_CYCLES

static int DEFAULT_THREADS

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ALIAS`
`static String`	`DEFAULT_ATYPE`
`static String`	`DEFAULT_CYCLES`
`static int`	`DEFAULT_THREADS`

Constructor Summary

Constructors
Constructor and Description

ActivityDef(ParameterMap parameterMap)

Constructors
Constructor and Description
`ActivityDef(ParameterMap parameterMap)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getActivityType()`
`String`	`getAlias()` The alias that the associated activity instance is known by.
`AtomicLong`	`getChangeCounter()`
`long`	`getCycleCount()`
`String`	`getCycleSummary()`
`long`	`getEndCycle()` The last cycle that will be used for execution of this activity, inclusive.
`ParameterMap`	`getParams()` Get the parameter map, which is the backing-store for all data within an ActivityDef.
`long`	`getStartCycle()` The first cycle that will be used for execution of this activity, inclusive.
`int`	`getThreads()` The number of threads (AKA slots) that the associated activity should currently be using.
`static ActivityDef`	`parseActivityDef(String namedActivitySpec)`
`static Optional<ActivityDef>`	`parseActivityDefOptionally(String namedActivitySpec)`
`void`	`setCycles(String cycles)`
`void`	`setEndCycle(long endCycle)`
`void`	`setEndCycle(String endCycle)`
`void`	`setStartCycle(long startCycle)`
`void`	`setStartCycle(String startCycle)`
`void`	`setThreads(int threads)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ALIAS
```
public static final String DEFAULT_ALIAS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ATYPE
```
public static final String DEFAULT_ATYPE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CYCLES
```
public static final String DEFAULT_CYCLES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THREADS
```
public static final int DEFAULT_THREADS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ActivityDef
```
public ActivityDef(ParameterMap parameterMap)
```
- Method Detail
  - parseActivityDefOptionally
```
public static Optional<ActivityDef> parseActivityDefOptionally(String namedActivitySpec)
```
  - parseActivityDef
```
public static ActivityDef parseActivityDef(String namedActivitySpec)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAlias
```
public String getAlias()
```
    The alias that the associated activity instance is known by.
    
    Returns:
    
    the alias
  - getActivityType
```
public String getActivityType()
```
  - getStartCycle
```
public long getStartCycle()
```
    The first cycle that will be used for execution of this activity, inclusive. If the value is provided as a range as in 0..10, then the first number is the start cycle and the second number is the end cycle +1. Effectively, cycle ranges are [closed,open) intervals, as in [min..max)
    
    Returns:
    
    the long start cycle
  - setStartCycle
```
public void setStartCycle(String startCycle)
```
  - setStartCycle
```
public void setStartCycle(long startCycle)
```
  - setEndCycle
```
public void setEndCycle(String endCycle)
```
  - getEndCycle
```
public long getEndCycle()
```
    The last cycle that will be used for execution of this activity, inclusive.
    
    Returns:
    
    the long end cycle
  - setEndCycle
```
public void setEndCycle(long endCycle)
```
  - getThreads
```
public int getThreads()
```
    The number of threads (AKA slots) that the associated activity should currently be using.
    
    Returns:
    
    target thread count
  - setThreads
```
public void setThreads(int threads)
```
  - getParams
```
public ParameterMap getParams()
```
    Get the parameter map, which is the backing-store for all data within an ActivityDef.
    
    Returns:
    
    the parameter map
  - getChangeCounter
```
public AtomicLong getChangeCounter()
```
  - setCycles
```
public void setCycles(String cycles)
```
  - getCycleSummary
```
public String getCycleSummary()
```
  - getCycleCount
```
public long getCycleCount()
```

Class ActivityDef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ALIAS

DEFAULT_ATYPE

DEFAULT_CYCLES

DEFAULT_THREADS

Constructor Detail

ActivityDef

Method Detail

parseActivityDefOptionally

parseActivityDef

toString

getAlias

getActivityType

getStartCycle

setStartCycle

setStartCycle

setEndCycle

getEndCycle

setEndCycle

getThreads

setThreads

getParams

getChangeCounter

setCycles

getCycleSummary

getCycleCount