PerformanceData (ATG Java API)

java.lang.Object
- atg.service.perfmonitor.PerformanceData

All Implemented Interfaces:

Resetable, java.io.Serializable
```
public class PerformanceData
extends java.lang.Object
implements Resetable, java.io.Serializable
```
This object contains the values for minimum, maximum, total executions, and total execution time for an operation. When an operation completes, the total execution time is determined and passed to this object. The increaseTotalExecutionTime method is called with the time in milliseconds passed as the argument. Based on this information, the properties of this object are updated.
The properties of this object are definied as follows:
- Minimum Execution Time - the shortest time that this operation took out of all executions
- Maximum Execution Time - the longest time that this operation took out of all executions
- Total Number of Executions - the total number of executions for this operation since the Performance Monitor was started or the last reset
- Total Execution Time - the total amount of time out of all executions that this operation took
- Average Execution Time - the average amount of time out of all executions that this operation takes
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION`

Constructor Summary

Constructors
Constructor and Description

PerformanceData()
Constructs a PerformanceData object.

Constructors
Constructor and Description
`PerformanceData()` Constructs a PerformanceData object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getAverageExecutionTime()` Returns property averageExecutionTime
`double`	`getAverageMemoryRequired()` Returns property averageMemoryRequired
`long`	`getMaximumExecutionTime()` Returns property maximumExecutionTime
`double`	`getMaximumMemoryRequired()` Returns property maximumMemoryRequired
`long`	`getMemTotalNumberOfExecutions()` Returns property memTotalNumberOfExecutions
`long`	`getMinimumExecutionTime()` Returns property minimumExecutionTime
`double`	`getMinimumMemoryRequired()` Returns property minimumMemoryRequired
`long`	`getTotalExecutionTime()` Returns property totalExecutionTime
`double`	`getTotalMemoryRequired()` Returns property totalMemoryRequired
`long`	`getTotalNumberOfExecutions()` Returns property totalNumberOfExecutions
`void`	`increaseTotalExecutionTime(long pTime)` Increases the totalExecutionTime by the amount in pTime.
`void`	`increaseTotalMemoryRequired(double pMemory)` Increases the totalMemoryRequired by the amount in pMemory.
`void`	`reset()` Resets the properties of this object back to their defaults
`void`	`resetMemoryData()` Resets the properties of this object back to their defaults

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

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
- Constructor Detail
  - PerformanceData
```
public PerformanceData()
```
    Constructs a PerformanceData object.
- Method Detail
  - increaseTotalExecutionTime
```
public void increaseTotalExecutionTime(long pTime)
```
    Increases the totalExecutionTime by the amount in pTime. Also increments the totalNumberOfExecutions by 1 and updates the minimumExecutionTime and maximumExecutionTime if necessary.
    
    Parameters:
    
    pTime - the amount to increment mTotalExecutionTime by.
  - increaseTotalMemoryRequired
```
public void increaseTotalMemoryRequired(double pMemory)
```
    Increases the totalMemoryRequired by the amount in pMemory. Also updates the minimumMemoryRequired and maximumMemoryRequired if necessary.
    
    Parameters:
    
    pMemory - the amount to increment mTotalMemoryRequired by.
  - reset
```
public void reset()
```
    Resets the properties of this object back to their defaults
    
    Specified by:
    
    reset in interface Resetable
  - resetMemoryData
```
public void resetMemoryData()
```
    Resets the properties of this object back to their defaults
  - getMinimumExecutionTime
```
public long getMinimumExecutionTime()
```
    Returns property minimumExecutionTime
  - getMaximumExecutionTime
```
public long getMaximumExecutionTime()
```
    Returns property maximumExecutionTime
  - getTotalNumberOfExecutions
```
public long getTotalNumberOfExecutions()
```
    Returns property totalNumberOfExecutions
  - getTotalExecutionTime
```
public long getTotalExecutionTime()
```
    Returns property totalExecutionTime
  - getAverageExecutionTime
```
public long getAverageExecutionTime()
```
    Returns property averageExecutionTime
  - getMemTotalNumberOfExecutions
```
public long getMemTotalNumberOfExecutions()
```
    Returns property memTotalNumberOfExecutions
  - getMinimumMemoryRequired
```
public double getMinimumMemoryRequired()
```
    Returns property minimumMemoryRequired
  - getMaximumMemoryRequired
```
public double getMaximumMemoryRequired()
```
    Returns property maximumMemoryRequired
  - getTotalMemoryRequired
```
public double getTotalMemoryRequired()
```
    Returns property totalMemoryRequired
  - getAverageMemoryRequired
```
public double getAverageMemoryRequired()
```
    Returns property averageMemoryRequired

Class PerformanceData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

Constructor Detail

PerformanceData

Method Detail

increaseTotalExecutionTime

increaseTotalMemoryRequired

reset

resetMemoryData

getMinimumExecutionTime

getMaximumExecutionTime

getTotalNumberOfExecutions

getTotalExecutionTime

getAverageExecutionTime

getMemTotalNumberOfExecutions

getMinimumMemoryRequired

getMaximumMemoryRequired

getTotalMemoryRequired

getAverageMemoryRequired