ilog.tgo.model
Class IltTrap

java.lang.Object
  ilog.tgo.model.IltTrap

public class IltTrap
extends Object

This class provides the state system which contains the class IltTrap.State. The latter class models the traps carried by a telecom object.

See Also:

IltObjectState.getTrapState()

Nested Class Summary

static class	IltTrap.State This class provides a representation model for the traps carried by a telecom object.
static class	IltTrap.Type This enumeration lists the possible types of traps supported by the system.

Constructor Summary

protected

IltTrap() Default constructor

Method Summary

static void	ForceInit(ilog.tgo.util.internal.IltForceClassInit object) For IltSystem.Init
static IltAlarmSystem	GetAlarmSystem() Returns the only instance of IltTrap.
static void	SetTypeMapping(IltTrap.Type t, Color normal, Color bright, Color dark, String mnemonic, String description) Deprecated. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.
static void	SetTypeMapping(IltTrap.Type t, IlpColorKey normalKey, Color defaultNormalValue, IlpColorKey brightKey, Color defaultBrightValue, IlpColorKey darkKey, Color defaultDarkValue, IlpStringKey abbreviationKey, String defaultAbbreviationValue, IlpStringKey expandedKey, String defaultExpandedValue) Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.
static void	SetTypeMapping(IltTrap.Type t, IltKey.Color normalKey, Color defaultNormalValue, IltKey.Color brightKey, Color defaultBrightValue, IltKey.Color darkKey, Color defaultDarkValue, IltKey.String abbreviationKey, String defaultAbbreviationValue, IltKey.String expandedKey, String defaultExpandedValue) Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltTrap

protected IltTrap()

Default constructor

Method Detail

GetAlarmSystem

public static IltAlarmSystem GetAlarmSystem()

Returns the only instance of IltTrap.

Internal method or field: do not use!

SetTypeMapping

public static void SetTypeMapping(IltTrap.Type t,
                                  Color normal,
                                  Color bright,
                                  Color dark,
                                  String mnemonic,
                                  String description)

Deprecated. Use IltSettings.SetValue(java.lang.Object, java.lang.Object) instead.

Installs a graphical representation mapping for a trap type.

The trap type representation shall now be customized using IltSettings.SetValue(java.lang.Object, java.lang.Object). The following properties are available:

• Trap.Type.name.Color
• Trap.Type.name.BrightColor
• Trap.Type.name.DarkColor
• Trap.Type.name.Abbreviation
• Trap.Type.name.Description

Instead of calling this method, use:

 IltSettings.SetValue("Trap.Type.name.Color", normal);
 IltSettings.SetValue("Trap.Type.name.BrightColor", bright);
 IltSettings.SetValue("Trap.Type.name.DarkColor", dark);
 IltSettings.SetValue("Trap.Type.name.Abbreviation", mnemonic);
 IltSettings.SetValue("Trap.Type.name.Description", description);
 

See Also:

IltSettings

Deprecated Since:

JTGO 4.5

SetTypeMapping

public static void SetTypeMapping(IltTrap.Type t,
                                  IltKey.Color normalKey,
                                  Color defaultNormalValue,
                                  IltKey.Color brightKey,
                                  Color defaultBrightValue,
                                  IltKey.Color darkKey,
                                  Color defaultDarkValue,
                                  IltKey.String abbreviationKey,
                                  String defaultAbbreviationValue,
                                  IltKey.String expandedKey,
                                  String defaultExpandedValue)

Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.

Installs a graphical representation mapping for a trap type. For this new type, the colors and string will be found through IltKeys in the legend of the object to draw. The default values will be installed in the IltObject class legend, so that the keys are served for any IltObject.

You can create 5 new IltKey instances and choose the default values you want. All objects with a trap of this type will be drawn using these default values, except if you set the keys locally in the object legend.

The trap type representation shall now be customized using IltSettings.SetValue(java.lang.Object, java.lang.Object). The following properties are available:

• Trap.Type.name.Color
• Trap.Type.name.BrightColor
• Trap.Type.name.DarkColor
• Trap.Type.name.Abbreviation
• Trap.Type.name.Description

Instead of calling this method, use:

 IltSettings.SetValue("Trap.Type.name.Color", normal);
 IltSettings.SetValue("Trap.Type.name.BrightColor", bright);
 IltSettings.SetValue("Trap.Type.name.DarkColor", dark);
 IltSettings.SetValue("Trap.Type.name.Abbreviation", mnemonic);
 IltSettings.SetValue("Trap.Type.name.Description", description);
 

See Also:

IltSettings

Deprecated Since:

JTGO 3.0

SetTypeMapping

public static void SetTypeMapping(IltTrap.Type t,
                                  IlpColorKey normalKey,
                                  Color defaultNormalValue,
                                  IlpColorKey brightKey,
                                  Color defaultBrightValue,
                                  IlpColorKey darkKey,
                                  Color defaultDarkValue,
                                  IlpStringKey abbreviationKey,
                                  String defaultAbbreviationValue,
                                  IlpStringKey expandedKey,
                                  String defaultExpandedValue)

Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.

Installs a graphical representation mapping for a trap type. For this new type, the colors and string will be found through IltKeys in the legend of the object to draw. The default values will be installed in the IltObject class legend, so that the keys are served for any IltObject.

You can create 5 new IltKey instances and choose the default values you want. All objects with a trap of this type will be drawn using these default values, except if you set the keys locally in the object legend.

The trap type representation shall now be customized using IltSettings.SetValue(java.lang.Object, java.lang.Object). The following properties are available:

• Trap.Type.name.Color
• Trap.Type.name.BrightColor
• Trap.Type.name.DarkColor
• Trap.Type.name.Abbreviation
• Trap.Type.name.Description

Instead of calling this method, use:

 IltSettings.SetValue("Trap.Type.name.Color", normal);
 IltSettings.SetValue("Trap.Type.name.BrightColor", bright);
 IltSettings.SetValue("Trap.Type.name.DarkColor", dark);
 IltSettings.SetValue("Trap.Type.name.Abbreviation", mnemonic);
 IltSettings.SetValue("Trap.Type.name.Description", description);
 

Since:

JTGO 3.0

See Also:

IltSettings

Deprecated Since:

JTGO 3.5

ForceInit

public static void ForceInit(ilog.tgo.util.internal.IltForceClassInit object)

For IltSystem.Init

Internal method or field: do not use!