IltBellcoreObjectState (Perforce JViews 10.0 API)

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

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 IltBellcoreObjectState
extends IltObjectState
implements Cloneable
```
An instance of this class is the state of some telecom object, as defined by the Bellcore standard.
It uses the elements of the IltBellcore state system, and also the extension provided by the IltMisc state system, the IltPerformance state system, the IltSAN state system and the alarm model provided by IltAlarm.
This class therefore contains three attributes:
- the Bellcore state of the telecom object, embodied by an IltBellcore.State instance,
- the list of secondary states of the telecom object, whether IltBellcore.SecState instances, IltMisc.SecState instances, IltPerformance.SecState instances or IltSAN 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
`IltBellcoreObjectState()` Creates a new `IltBellcoreObjectState` with the Bellcore state initialized to `DefaultState`, no secondary states and no alarms.
`IltBellcoreObjectState(IltBellcore.State state)` Creates a new `IltBellcoreObjectState` with the given Bellcore state, no secondary states and no alarms.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addSecState(IltState state)` Adds a given state to the list of secondary states.
`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 IltBellcore.State`	`GetDefaultState()` Returns the default Bellcore state for a new object.
`IltState`	`getPrimaryState()` Returns the primary state present in this object state.
`Enumeration`	`getSecStates()` Returns an enumeration of the secondary states.
`IltBellcore.State`	`getState()` Returns the Bellcore state of the telecom object.
`boolean`	`has(IltState state)` Tests whether this state contains a given constant state (defined in a state system).
`boolean`	`hasSecState(IltState state)` Tests whether a given state is among the secondary states listed.
`void`	`removeAllSecStates()` Removes all secondary states currently set in this object state.
`boolean`	`removeSecState(IltState state)` Removes a given state from the list of secondary states.
`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(IltBellcore.State state)` Sets the default Bellcore state for a new object.
`void`	`setSecStates(Enumeration states)` Replaces the list of secondary states with the contents of a given enumeration.
`void`	`setState(IltBellcore.State state)` Sets the Bellcore state of the telecom object.

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
  - IltBellcoreObjectState
```
public IltBellcoreObjectState(IltBellcore.State state)
```
    Creates a new IltBellcoreObjectState with the given Bellcore state, no secondary states and no alarms.
  - IltBellcoreObjectState
```
public IltBellcoreObjectState()
```
    Creates a new IltBellcoreObjectState with the Bellcore state initialized to DefaultState, no secondary states and no alarms.
- Method Detail
  - GetDefaultState
```
public static IltBellcore.State GetDefaultState()
```
    Returns the default Bellcore state for a new object.
  - SetDefaultState
```
public static void SetDefaultState(IltBellcore.State state)
```
    Sets the default Bellcore state for a new object. This method also affects objects after a reset or a clear using the primary state.
    
    Internal: do not use!
  - clone
```
public Object clone()
```
    Returns a copy of this state object.
    
    Overrides:
    
    clone in class IltObjectState
  - getState
```
public IltBellcore.State getState()
```
    Returns the Bellcore state of the telecom object.
  - setState
```
public void setState(IltBellcore.State state)
```
    Sets the Bellcore state of the telecom object.
  - hasSecState
```
public boolean hasSecState(IltState state)
```
    Tests whether a given state is among the secondary states listed.
  - addSecState
```
public boolean addSecState(IltState state)
```
    Adds a given state to the list of secondary states.
    
    Returns:
    
    true if the state was already among the secondary states.
  - removeSecState
```
public boolean removeSecState(IltState state)
```
    Removes a given state from the list of secondary states.
    
    Returns:
    
    true if the state was among the secondary states.
  - removeAllSecStates
```
public void removeAllSecStates()
```
    Removes all secondary states currently set in this object state.
  - getSecStates
```
public Enumeration getSecStates()
```
    Returns an enumeration of the secondary states.
    
    Returns:
    
    an enumeration of IltState
  - setSecStates
```
public void setSecStates(Enumeration states)
```
    Replaces the list of secondary states with the contents of a given enumeration.
    
    Parameters:
    
    states - an enumeration of IltState
  - 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 IltBellcoreObjectState

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

IltBellcoreObjectState

IltBellcoreObjectState

Method Detail

GetDefaultState

SetDefaultState

clone

getState

setState

hasSecState

addSecState

removeSecState

removeAllSecStates

getSecStates

setSecStates

getAlarmState

setAlarmState

has

set

clear

reset

getPrimaryState