IltSONETObjectState (Rogue Wave JViews 9.1 API)

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

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

Direct Known Subclasses:

IltBiSONETObjectState
```
public class IltSONETObjectState
extends IltObjectState
implements Cloneable
```
An instance of this class is the state of some telecom object, as defined by the SONET standard.
It uses the elements of the IltSONET state system, and also the extension provided by the IltPerformance state system, the IltSAN state system and the alarm model provided by IltAlarm.
This class therefore contains four attributes:
- the SONET state of the telecom object, embodied by an IltSONET.State instance,
- the protection states of the telecom object, as IltSONET.Protection instances,
- the list of secondary states of the telecom object, as IltPerformance.SecState and IltSAN.SecState instances,
- the telecom object alarms, embodied by an IltAlarm.State instance.
See Also:

for the corresponding XML format

Field Summary

Fields
Modifier and Type Field and Description

static IltObjectStateInfo metainfo
Contains metainformation about this IltObjectState class.
- Fields inherited from interface ilog.cpl.model.internal.IlpCompositeAttributeValue
  ATTRIBUTE_NAME_DELIMITER

Fields
Modifier and Type	Field and Description
`static IltObjectStateInfo`	`metainfo` Contains metainformation about this `IltObjectState` class.

Constructor Summary

Constructors
Constructor and Description

IltSONETObjectState()

IltSONETObjectState(IltSONET.State state)
Creates a new SONET object state.

Constructors
Constructor and Description
`IltSONETObjectState()`
`IltSONETObjectState(IltSONET.State state)` Creates a new SONET object state.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProtection(IltSONET.End end, IltSONET.Protection state)` Adds a given protection from a given link end.
`boolean`	`clear(IltState state)` Removes a given constant state (defined in a state system) from this state.
`Object`	`clone()` Returns a copy of this state object.
`IltState`	`getAlarmState()` Returns the alarms part of the state.
`static IltSONET.State`	`GetDefaultState()` Returns the default SONET state for a new object.
`Vector`	`getFromProtections()` All access to the vector should be through this method.
`IltState`	`getPrimaryState()` Returns the primary state present in this object state.
`Enumeration`	`getProtections(IltSONET.End end)` Returns the protections at a given link end.
`IltSONET.State`	`getState()` Returns the general part of the state.
`Vector`	`getToProtections()` All access to the vector should be through this method.
`boolean`	`has(IltState state)` Tests whether this state contains a given constant state (defined in a state system).
`boolean`	`hasProtection(IltSONET.End end, IltSONET.Protection state)` Tells whether a given link end has a given protection.
`void`	`removeAllProtections(IltSONET.End end)` Removes all protections set in the given end point
`boolean`	`removeProtection(IltSONET.End end, IltSONET.Protection state)` Removes a given protection from a given link end.
`void`	`reset()` Resets all the state values for the telecom object.
`boolean`	`set(IltState state)` Adds a given constant state (defined in a state system) to this state.
`void`	`setAlarmState(IltAlarm.State state)` Sets the alarm state instance.
`static void`	`SetDefaultState(IltSONET.State state)` Sets the default SONET state for a new object.
`void`	`setProtections(IltSONET.End end, IltSONET.Protection[] newprotections)` Replaces the protections at a given link end.
`void`	`setState(IltSONET.State state)` Sets the general part of the state.

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: do not use!
- Constructor Detail
  - IltSONETObjectState
```
public IltSONETObjectState(IltSONET.State state)
```
    Creates a new SONET object state.
    
    Parameters:
    
    state - The primary state
  - IltSONETObjectState
```
public IltSONETObjectState()
```
- Method Detail
  - GetDefaultState
```
public static IltSONET.State GetDefaultState()
```
    Returns the default SONET state for a new object.
  - SetDefaultState
```
public static void SetDefaultState(IltSONET.State state)
```
    Sets the default SONET state for a new object. This method also affects objects after a reset or a clear using the primary state.
  - getFromProtections
```
public Vector getFromProtections()
```
    All access to the vector should be through this method. Lazy initialization
    
    Internal: do not use!
  - getToProtections
```
public Vector getToProtections()
```
    All access to the vector should be through this method. Lazy initialization
    
    Internal: do not use!
  - clone
```
public Object clone()
```
    Returns a copy of this state object.
    
    Overrides:
    
    clone in class IltObjectState
  - getState
```
public IltSONET.State getState()
```
    Returns the general part of the state.
  - setState
```
public void setState(IltSONET.State state)
```
    Sets the general part of the state.
  - hasProtection
```
public boolean hasProtection(IltSONET.End end,
                             IltSONET.Protection state)
```
    Tells whether a given link end has a given protection.
  - addProtection
```
public void addProtection(IltSONET.End end,
                          IltSONET.Protection state)
```
    Adds a given protection from a given link end.
  - removeProtection
```
public boolean removeProtection(IltSONET.End end,
                                IltSONET.Protection state)
```
    Removes a given protection from a given link end.
    
    Returns:
    
    true if the protection was present, false otherwise
  - getProtections
```
public Enumeration getProtections(IltSONET.End end)
```
    Returns the protections at a given link end.
    
    Returns:
    
    an enumeration of IltSONET.Protection
  - setProtections
```
public void setProtections(IltSONET.End end,
                           IltSONET.Protection[] newprotections)
```
    Replaces the protections at a given link end.
  - removeAllProtections
```
public void removeAllProtections(IltSONET.End end)
```
    Removes all protections set in the given end point
  - getAlarmState
```
public IltState getAlarmState()
```
    Returns the alarms part of the state.
    
    Overrides:
    
    getAlarmState in class IltObjectState
    
    Returns:
    
    an IltAlarm.State
  - setAlarmState
```
public void setAlarmState(IltAlarm.State state)
```
    Sets the alarm state instance.
    
    Internal: do not use!
  - has
```
public boolean has(IltState state)
```
    Description copied from class: IltObjectState
    
    Tests whether this state contains a given constant state (defined in a state system).
    
    Specified by:
    
    has in interface ilog.tgo.model.internal.IltStateValueCollection
    
    Overrides:
    
    has in class IltObjectState
    
    Parameters:
    
    state - State being tested.
    
    Returns:
    
    true when the given state is part of the collection.
  - set
```
public boolean set(IltState state)
```
    Description copied from class: IltObjectState
    
    Adds a given constant state (defined in a state system) to this state.
    
    Overrides:
    
    set in class IltObjectState
  - clear
```
public boolean clear(IltState state)
```
    Description copied from class: IltObjectState
    
    Removes a given constant state (defined in a state system) from this state.
    
    Specified by:
    
    clear in interface ilog.tgo.model.internal.IltStateValueCollection
    
    Overrides:
    
    clear in class IltObjectState
    
    Parameters:
    
    state - State to be removed.
    
    Returns:
    
    true when the operation resulted in a modification of the collection.
  - reset
```
public void reset()
```
    Description copied from class: IltObjectState
    
    Resets all the state values for the telecom object. When applicable, the state values are set to their default values.
    
    Overrides:
    
    reset in class IltObjectState
  - getPrimaryState
```
public IltState getPrimaryState()
```
    Returns the primary state present in this object state.
    
    Overrides:
    
    getPrimaryState in class IltObjectState
    
    Internal: do not use!

Class IltSONETObjectState

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.model.IltObjectState

Methods inherited from class java.lang.Object

Field Detail

metainfo

Constructor Detail

IltSONETObjectState

IltSONETObjectState

Method Detail

GetDefaultState

SetDefaultState

getFromProtections

getToProtections

clone

getState

setState

hasProtection

addProtection

removeProtection

getProtections

setProtections

removeAllProtections

getAlarmState

setAlarmState

has

set

clear

reset

getPrimaryState