ilog.tgo.model
Class IltBiSONETObjectState

java.lang.Object
  ilog.tgo.model.IltObjectState
      ilog.tgo.model.IltSONETObjectState
          ilog.tgo.model.IltBiSONETObjectState

All Implemented Interfaces:

ilog.cpl.model.internal.IlpCompositeAttributeValue, ilog.tgo.model.internal.IltStatePathValueCollection, ilog.tgo.model.internal.IltStateValueChangeNotifier, ilog.tgo.model.internal.IltStateValueCollection, ilog.tgo.model.internal.IltTypedStatePathValueCollection, ilog.tgo.model.internal.IltTypedStateValueCollection, ilog.tgo.model.state.event.IltAlarmSystemListener, ilog.tgo.model.state.event.IltStateSystemListener, Cloneable, EventListener

public class IltBiSONETObjectState
extends IltSONETObjectState
implements Cloneable

IltBiSONETObjectState instances store the state of telecom objects that follow the SONET dictionary modeled by the IltSONET state system.

It is particularly suitable for links which have one state for each direction of traffic. They also use the alarm model provided by the IltAlarm state system.

The IltBiSONETObjectState class therefore holds five attributes:

• the SONET state of the telecom object, embodied by two IltSONET.State instances, one for the direct (from-to-to direction) state and one for the reverse (to-to-from direction) state,
• two lists (one for each link end) of protection switch-related secondary states, each embodied by an IltSONET.Protection instance,
• the telecom object alarms, embodied by an IltAlarm.State instance.

The direct SONET state is considered the main state of the object. Therefore, it is the state accessed by the inherited generic methods set, get, and has as well as getState and setState. To change the reverse state, two new methods are provided: getReverseState and setReverseState.

The graphical representation of links with this object state is computed as follows:

• The direct state is represented by the color and the style of the inner part of the base of the link and the to arrow.
• The reverse state is represented by the color and the style of the outer part of the part of the link and the from arrow.
• The protections are represented by icons at each end.
• The alarms are represented by decorations in and around the plinth of the link.

See Also:

for the corresponding XML format

Field Summary

static IltObjectStateInfo

metainfo Contains metainformation about this IltObjectState class.

Fields inherited from interface ilog.cpl.model.internal.IlpCompositeAttributeValue

ATTRIBUTE_NAME_DELIMITER

Constructor Summary

IltBiSONETObjectState()
Creates an instance IltBiSONETObjectState with the default values.

IltBiSONETObjectState(IltSONET.State state, IltSONET.State reverseState)
Creates an instance of IltBiSONETObjectState with the given SONET states.

Method Summary

Object	clone() Returns a copy of this IltBiSONETObjectState instance.
static IltSONET.State	GetDefaultReverseState() Returns the default BiSONET reverse state for a new object.
IltSONET.State	getReverseState() Returns the SONET reverse state of the telecom object.
void	reset() Resets this object state.
static void	SetDefaultReverseState(IltSONET.State state) Sets the default BiSONET reverse state for a new object.
void	setReverseState(IltSONET.State reverseState) Sets the SONET reverse state of the telecom object to reverseState.

Methods inherited from class ilog.tgo.model.IltSONETObjectState

addProtection, clear, getAlarmState, GetDefaultState, getFromProtections, getPrimaryState, getProtections, getState, getToProtections, has, hasProtection, removeAllProtections, removeProtection, set, setAlarmState, SetDefaultState, setProtections, setState

Methods inherited from class ilog.tgo.model.IltObjectState

addObjectStateListener, attach, clear, detach, endChangingObjectState, equals, fireObjectStateChanged, fireObjectStateSet, get, get, getAggregate, getAggregate, getAlarmSystem, getAttributeValue, getBoolean, getBoolean, getFloat, getFloat, getInteger, getInteger, getListStrategy, getMapStrategy, getObjectStateInfo, getStateSystem, getStateValueTable, getSymbolic, getSymbolic, getTrapState, has, inverseStates, inverseValues, isValid, list, map, removeObjectStateListener, set, set, setAggregate, setAggregate, setAlarmSystem, setBoolean, setBoolean, setFloat, setFloat, setInteger, setInteger, setListStrategy, setMapStrategy, setStateSystem, setSymbolic, setSymbolic, severityAdded, severityRemoved, startChangingObjectState, stateAdded, stateRemoved, states, stateSystemAdded, stateSystemRemoved, values

Methods inherited from class java.lang.Object

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

Field Detail

metainfo

public static IltObjectStateInfo metainfo

Contains metainformation about this IltObjectState class.

Internal method or field: do not use!

Constructor Detail

IltBiSONETObjectState

public IltBiSONETObjectState(IltSONET.State state,
                             IltSONET.State reverseState)

Creates an instance of IltBiSONETObjectState with the given SONET states.

The following values are used:

• an empty list of protection switch secondary state values for the from link end,
• an empty list of protection switch secondary state values for the to link end,
• an IltAlarm.State instance initialized with its default values, that is, no alarms.

Parameters:

state - SONET state for the direct state of the link.

reverseState - SONET state for the reverse state of the link.

IltBiSONETObjectState

public IltBiSONETObjectState()

Creates an instance IltBiSONETObjectState with the default values.

The following values are used:

• for the SONET state of the object, it is the default value stored in IltSONETObjectState.DefaultState (in the default implementation, this value is IltSONET.State.Inactive),
• for the SONET reverse state of the object, it is the default value stored in DefaultReverseState (in the default implementation, this value is IltSONET.State.Inactive),
• an empty list of protection switch secondary state values for the from link end,
• an empty list of protection switch secondary state values for the to link end,
• an IltAlarm.State instance initialized with its default values, that is, no alarms.

Method Detail

GetDefaultReverseState

public static IltSONET.State GetDefaultReverseState()

Returns the default BiSONET reverse state for a new object.

SetDefaultReverseState

public static void SetDefaultReverseState(IltSONET.State state)

Sets the default BiSONET reverse state for a new object. This method also affects objects after a reset or a clear using the primary state.

clone

public Object clone()

Returns a copy of this IltBiSONETObjectState instance.

Overrides:

clone in class IltSONETObjectState

getReverseState

public IltSONET.State getReverseState()

Returns the SONET reverse state of the telecom object.

setReverseState

public void setReverseState(IltSONET.State reverseState)

Sets the SONET reverse state of the telecom object to reverseState.

reset

public void reset()

Resets this object state.

Overrides:

reset in class IltSONETObjectState