Package adams.flow.container

Class TimingContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.TimingContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class TimingContainer
extends AbstractContainer

Container to store timing information from actor execution.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_MSEC	the identifier for the msec.
static String	VALUE_ORIGIN	the identifier for the origin.
static String	VALUE_PREFIX	the identifier for the optional prefix.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
TimingContainer()	Initializes the container with no prefix and origin and a msec value of 0.0.
TimingContainer(double msec)	Initializes the container with no prefix and origin and the specified msec value.
TimingContainer(double msec, String prefix, String origin)	Initializes the container with the specified plot name and no X value.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_MSEC

public static final String VALUE_MSEC

the identifier for the msec.

See Also:

Constant Field Values

VALUE_PREFIX

public static final String VALUE_PREFIX

the identifier for the optional prefix.

See Also:

Constant Field Values

VALUE_ORIGIN

public static final String VALUE_ORIGIN

the identifier for the origin.

See Also:

Constant Field Values

Constructor Detail

TimingContainer

public TimingContainer()

Initializes the container with no prefix and origin and a msec value of 0.0.

Only used for generating help information.

TimingContainer

public TimingContainer(double msec)

Initializes the container with no prefix and origin and the specified msec value.

Parameters:

msec - the timing in msec

TimingContainer

public TimingContainer(double msec,
                       String prefix,
                       String origin)

Initializes the container with the specified plot name and no X value.

Parameters:

msec - the timing in msec

prefix - the prefix to use, can be null

origin - the origin of the timing, can be null

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

iterator over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available