public class IltOSIObjectState extends IltObjectState implements Cloneable
It uses the elements of the IltOSI
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 the IltAlarm
state
system.
This class therefore contains three attributes:
IltOSI.State
instance, IltOSI.Availability
, IltOSI.Control
,
IltOSI.Procedural
, IltOSI.Standby
instances, IltMisc.SecState
instances,
IltPerformance.SecState
instances or
IltSAN
instances, IltAlarm.State
instance. for the corresponding XML format
Modifier and Type | Field and Description |
---|---|
static IltObjectStateInfo |
metainfo
Contains metainformation about this
IltObjectState class. |
Constructor and Description |
---|
IltOSIObjectState()
Creates a new
IltOSIObjectState with the OSI state
initialized to DefaultState , no statuses and no alarms. |
IltOSIObjectState(IltOSI.State state)
Creates a new
IltOSIObjectState with the given
OSI state, no statuses and no alarms. |
Modifier and Type | Method and Description |
---|---|
boolean |
addStatus(IltState state)
Adds
state to the list of statuses of the telecom object. |
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 IltOSI.State |
GetDefaultState()
Returns the default OSI state for a new object.
|
IltState |
getPrimaryState()
Returns the primary state present in this object state.
|
IltOSI.State |
getState()
Returns the OSI status of the telecom object.
|
Enumeration |
getStatuses()
Returns an enumeration of the statuses of the telecom object listed.
|
boolean |
has(IltState state)
Tests whether this state contains a given constant state (defined in
a state system).
|
boolean |
hasStatus(IltState state)
Tests whether a given
state is among the statuses
of the telecom object listed. |
void |
removeAllStatuses()
Removes all secondary states currently set in this instance.
|
boolean |
removeStatus(IltState state)
Removes
state from the list of statuses of the telecom
object. |
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(IltOSI.State state)
Sets the default OSI state for a new object.
|
void |
setState(IltOSI.State state)
Sets the OSI state of the telecom object.
|
void |
setStatuses(Enumeration states)
Replaces the list of statuses with the contents of a given enumeration.
|
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
public static IltObjectStateInfo metainfo
IltObjectState
class.public IltOSIObjectState(IltOSI.State state)
IltOSIObjectState
with the given
OSI state, no statuses and no alarms.public IltOSIObjectState()
IltOSIObjectState
with the OSI state
initialized to DefaultState
, no statuses and no alarms.public static IltOSI.State GetDefaultState()
public static void SetDefaultState(IltOSI.State state)
reset
or a clear
using the primary state.public Object clone()
clone
in class IltObjectState
public IltOSI.State getState()
public void setState(IltOSI.State state)
state
is not copied.public boolean hasStatus(IltState state)
state
is among the statuses
of the telecom object listed.public boolean addStatus(IltState state)
state
to the list of statuses of the telecom object.public boolean removeStatus(IltState state)
state
from the list of statuses of the telecom
object.public void removeAllStatuses()
public Enumeration getStatuses()
IltState
public void setStatuses(Enumeration states)
states
- an enumeration of IltState
public IltState getAlarmState()
getAlarmState
in class IltObjectState
public void setAlarmState(IltAlarm.State state)
public boolean has(IltState state)
IltObjectState
has
in interface ilog.tgo.model.internal.IltStateValueCollection
has
in class IltObjectState
state
- State being tested.true
when the given state is part of the collection.public boolean set(IltState state)
IltObjectState
set
in class IltObjectState
public boolean clear(IltState state)
IltObjectState
clear
in interface ilog.tgo.model.internal.IltStateValueCollection
clear
in class IltObjectState
state
- State to be removed.true
when the operation resulted in a modification of
the collection.public void reset()
IltObjectState
reset
in class IltObjectState
public IltState getPrimaryState()
getPrimaryState
in class IltObjectState
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.