com.xj.anylogic.engine
Enum VariableDelay.Type

java.lang.Object
  java.lang.Enum<VariableDelay.Type>
      com.xj.anylogic.engine.VariableDelay.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VariableDelay.Type>

Enclosing class:

VariableDelay

public static enum VariableDelay.Type
extends java.lang.Enum<VariableDelay.Type>

Type of delay object, see description on items

Author:

XJ Technologies Company Ltd. www.anylogic.com

Enum Constant Summary

EXACT_DELAY
Delay returns the value of input at CurrentTime - DelayTime.

INFORMATION_DELAY
Delay represents a channel of length DelayTime with input and output.

MATERIAL_DELAY
Delay represents a channel of length DelayTime with input and output.

Method Summary

static VariableDelay.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VariableDelay.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXACT_DELAY

public static final VariableDelay.Type EXACT_DELAY

• Delay returns the value of input at CurrentTime - DelayTime.
  
• When DelayTime increases, delay holds the last returned value or returns MissingValue (if specified).

The behavior of this delay differs from information/material delay: output always equals to the input received DelayTime ago

INFORMATION_DELAY

public static final VariableDelay.Type INFORMATION_DELAY

• Delay represents a channel of length DelayTime with input and output.
• At the moment when DelayTime increases, the input part of channel is extended and instantly filled by the last input value of delay.
• At the moment when DelayTime decreases, the input part of required cutback of the channel is trimmed, and samples contained in this part are discarded.

Each time after delayTime changes, there is a period when output of the function is not equal to its input received DelayTime ago

MATERIAL_DELAY

public static final VariableDelay.Type MATERIAL_DELAY

• Delay represents a channel of length DelayTime with input and output.
• At the moment when DelayTime increases, the input part of channel is extended and instantly filled with MissingValue-samples.
• At the moment when DelayTime decreases, the input part of required cutback of the channel is cut and taken from the channel, and samples contained in this part and sequentially added to the next inputs.
  Note if there are MissingValue-samples in this "cut and taken" part, they aren't added to the inputs.

Each time after delayTime changes, there is a period when output of the function is not equal to its input received DelayTime ago

Method Detail

values

public static VariableDelay.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VariableDelay.Type c : VariableDelay.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VariableDelay.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null