ilog.tgo.model

Class IltNumericState

java.lang.Object

ilog.tgo.model.IltState

ilog.tgo.model.IltSimpleState

ilog.tgo.model.IltNumericState

All Implemented Interfaces:

IltDecorationSource, IlWithProperties

Direct Known Subclasses:

IltLimitedNumericState

public class IltNumericState
extends IltSimpleState

This class models states which can have a numeric value.

Instances of this class should only be set together with an associated value. The value must be of any of the following types:

• Number,
• int[],
• long[],
• float[],
• double[], or
• Number[].

When instances of this class are created, it is possible to define default values, so that when a certain telecom object instance is created and uses a certain state model which contains this simple state, the default value is automatically assigned to the object.

See Also:

IltObjectState.getInteger(ilog.tgo.model.IltNumericState), IltObjectState.getFloat(ilog.tgo.model.IltNumericState), IltObjectState.setInteger(ilog.tgo.model.IltNumericState, int), IltObjectState.setFloat(ilog.tgo.model.IltNumericState, float), IltObjectState.set(IltState, Object)

Field Summary

Fields

Modifier and Type	Field and Description
static IltStateInfo	metainfo Contains metainformation about this IltNumericState class.

Fields inherited from class ilog.tgo.model.IltState

_message

Constructor Summary

Constructors

Constructor and Description
IltNumericState(String name, String description, Number defaultValue) Creates an IltNumericState.
IltNumericState(String name, String description, String message, Number defaultValue) Creates an IltNumericState.

Method Summary

Modifier and Type	Method and Description
double	getDouble(Object value) Extracts a double from the value object stored for this state.
String	getToolTipText(IlpContext context, IltObject obj) Returns a description of the state.
String	getToolTipText(IltObject obj) Deprecated. Please use the two-argument getToolTipText method instead.
boolean	isValid(Object value) This method verifies if the given value can be set in the state.
void	list(IlpContext context, IltStateListing listing, Object value) Generates a plain text listing of a state.

Methods inherited from class ilog.tgo.model.IltSimpleState

createValue, getDefault, hasDefault, setDefault

Methods inherited from class ilog.tgo.model.IltState

copy, CreateNameFilter, CreateStateFilter, equals, getAliases, getAllPaths, getAltName, getDescription, getName, getProperty, getStateInfo, hasDescription, hashCode, intern, isInside, IsPropertyTransient, removeProperty, setAltName, setDescription, setMessage, setName, setProperty, SetPropertyTransient, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

metainfo

public static IltStateInfo metainfo

Contains metainformation about this IltNumericState class.

Internal: do not use!

Constructor Detail

IltNumericState

public IltNumericState(String name,
                       String description,
                       Number defaultValue)

Creates an IltNumericState.

Parameters:

description - optional attribute, which defines a textual description of the state.

defaultValue - optional attribute which defines a default value for this state.

IltNumericState

public IltNumericState(String name,
                       String description,
                       String message,
                       Number defaultValue)

Creates an IltNumericState.

Parameters:

description - optional attribute, which defines a textual description of the state.

message - catalog message

defaultValue - optional attribute which defines a default value for this state.

Method Detail

isValid

public boolean isValid(Object value)

This method verifies if the given value can be set in the state. If the value is valid, this method returns true.

Overrides:

isValid in class IltState

Internal: do not use!

list

public void list(IlpContext context,
                 IltStateListing listing,
                 Object value)

Generates a plain text listing of a state. The text is generated when the value of the state is true.

Overrides:

list in class IltState

Internal: do not use!

getToolTipText

@Deprecated
public String getToolTipText(IltObject obj)

Deprecated. Please use the two-argument getToolTipText method instead.

Returns a description of the state.

Specified by:

getToolTipText in interface IltDecorationSource

Overrides:

getToolTipText in class IltState

Internal: do not use!

Deprecated Since:

JTGO 3.1

getToolTipText

public String getToolTipText(IlpContext context,
                             IltObject obj)

Returns a description of the state.

Specified by:

getToolTipText in interface IltDecorationSource

Overrides:

getToolTipText in class IltState

Internal: do not use!

getDouble

public double getDouble(Object value)

Extracts a double from the value object stored for this state.

Internal: do not use!