RunInfo (PerfCake API Documentation (version 7.5))

java.lang.Object
- org.perfcake.RunInfo

All Implemented Interfaces:

Serializable
```
public class RunInfo
extends Object
implements Serializable
```
Information about the current scenario run.

Author:

Martin Večeřa

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RunInfo(Period duration)
Creates a new RunInfo.

Constructors
Constructor and Description
`RunInfo(Period duration)` Creates a new RunInfo.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTag(String tag)` Associates a new tag with this measurement.
`void`	`addTags(Set<String> tags)` Adds a set of tags to be associated with the current measurement.
`Period`	`getDuration()` Gets the desired run duration
`long`	`getEndTime()` Gets Unix time of the measurement end.
`long`	`getIteration()` Gets the current iteration counter value.
`long`	`getNextIteration()` Gets the next iteration counter value.
`double`	`getPercentage()` Gets the current measurement progress in percents.
`double`	`getPercentage(long iteration)` Gets the theoretical measurement progress in percents based on the provided number of passed iterations.
`long`	`getRunTime()` Gets the current measurement run time in millisecond.
`String`	`getScenarioName()` Gets the current scenario name.
`long`	`getStartTime()` Gets Unix time of the measurement start.
`Set<String>`	`getTags()` Gets an unmodifiable set of tags associated with this measurement run.
`int`	`getThreads()` Returns number of threads that is currently used to generate the load.
`boolean`	`hasTag(String tag)` Checks for a presence of a given tag.
`boolean`	`isRunning()` Is there a running measurement?
`boolean`	`isStarted()` Was the measurement started?
`void`	`removeTag(String tag)` Removes a tag from this run.
`void`	`reset()` Resets this RunInfo to its original state.
`void`	`setScenarioName(String scenarioName)` Sets the current scenario name.
`void`	`setThreads(int threads)` Sets the information about the number of threads that is currently used to generate the load.
`void`	`start()` Starts a new measurement run.
`void`	`stop()` Stops the measurement run.
`String`	`toString()`

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

- Constructor Detail
  - RunInfo
```
public RunInfo(Period duration)
```
    Creates a new RunInfo.
    
    Parameters:
    
    duration - Target duration of the run (time or iterations)
- Method Detail
  - start
```
public void start()
```
    Starts a new measurement run. This resets the iteration counter.
  - reset
```
public void reset()
```
    Resets this RunInfo to its original state. If there is a running measurement, a new start time is obtained for the measurement to be able to continue smoothly.
  - stop
```
public void stop()
```
    Stops the measurement run.
  - getIteration
```
public long getIteration()
```
    Gets the current iteration counter value. This can be used as an approximate value of passed iterations even though some of them might still be pending their execution.
    
    Returns:
    
    Current iteration counter value, -1 if there was no iteration so far.
  - getNextIteration
```
public long getNextIteration()
```
    Gets the next iteration counter value. This automatically increases the iteration counter for the next call to obtain a different value.
    
    Returns:
    
    The next available iteration counter value.
  - getRunTime
```
public long getRunTime()
```
    Gets the current measurement run time in millisecond. If the system clock changed during the running measurement, this value will be influenced.
    
    Returns:
    
    Current measurement run time.
  - getPercentage
```
public double getPercentage()
```
    Gets the current measurement progress in percents. If the run is limited by time based period and the system clock changed during the measurement, the result value will be influenced.
    
    Returns:
    
    Completed percents of the current measurement.
  - getPercentage
```
public double getPercentage(long iteration)
```
    Gets the theoretical measurement progress in percents based on the provided number of passed iterations. If the run is limited by time based period and the system clock changed during the measurement, the result value will be influenced.
    
    Parameters:
    
    iteration - The iteration for which we want to know the progress % number compared to the configured period duration.
    
    Returns:
    
    Completed percents of the theoretical measurement state. This cannot be more than 100% no matter what value is provided.
  - getStartTime
```
public long getStartTime()
```
    Gets Unix time of the measurement start. If the system clock changed during the measurement, this value will not represent the real start.
    
    Returns:
    
    Measurement start time.
  - getEndTime
```
public long getEndTime()
```
    Gets Unix time of the measurement end.
    
    Returns:
    
    Measurement end time.
  - isRunning
```
public boolean isRunning()
```
    Is there a running measurement? This is true if and only if isStarted() returns true and we did not reached the final iterations.
    
    Returns:
    
    True if the measurement is running.
  - isStarted
```
public boolean isStarted()
```
    Was the measurement started? This is true if and only if start() has been called and there has been no call to stop() since then.
    
    Returns:
    
    True if the measurement has been started.
  - getTags
```
public Set<String> getTags()
```
    Gets an unmodifiable set of tags associated with this measurement run.
    
    Returns:
    
    An unmodifiable set of tags.
  - hasTag
```
public boolean hasTag(String tag)
```
    Checks for a presence of a given tag.
    
    Parameters:
    
    tag - A tag to be checked.
    
    Returns:
    
    true if the specified tag is set for this run info.
  - addTag
```
public void addTag(String tag)
```
    Associates a new tag with this measurement.
    
    Parameters:
    
    tag - A new tag to be associated.
  - addTags
```
public void addTags(Set<String> tags)
```
    Adds a set of tags to be associated with the current measurement.
    
    Parameters:
    
    tags - A set of tags to be associated.
  - removeTag
```
public void removeTag(String tag)
```
    Removes a tag from this run.
    
    Parameters:
    
    tag - A tag to be removed.
  - getDuration
```
public Period getDuration()
```
    Gets the desired run duration
    
    Returns:
    
    The run duration.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getThreads
```
public int getThreads()
```
    Returns number of threads that is currently used to generate the load.
    
    Returns:
    
    The number of threads.
  - setThreads
```
public void setThreads(int threads)
```
    Sets the information about the number of threads that is currently used to generate the load.
    
    Parameters:
    
    threads - The number of threads.
  - getScenarioName
```
public String getScenarioName()
```
    Gets the current scenario name. This can carry any useful information. Gets filled by ScenarioLoader to the scenario file name.
    
    Returns:
    
    The scenario name.
  - setScenarioName
```
public void setScenarioName(String scenarioName)
```
    Sets the current scenario name. This is useful for reporting to refer to the original scenario file name for example.
    
    Parameters:
    
    scenarioName - The name of current scenario.

Class RunInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RunInfo

Method Detail

start

reset

stop

getIteration

getNextIteration

getRunTime

getPercentage

getPercentage

getStartTime

getEndTime

isRunning

isStarted

getTags

hasTag

addTag

addTags

removeTag

getDuration

toString

getThreads

setThreads

getScenarioName

setScenarioName