ilog.tgo.model

Class IltAlarmObjectState

java.lang.Object

ilog.tgo.model.IltObjectState

ilog.tgo.model.IltAlarmObjectState

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 IltAlarmObjectState
extends IltObjectState
implements Cloneable

An instance of this class is the state of some telecom object, which can be described through alarms only.

It uses the alarm system provided by the IltAlarm state system.

This class therefore contains one attribute:

• 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

Constructor Summary

Constructors

Constructor and Description
IltAlarmObjectState() Creates a new IltAlarmObjectState with no alarms.

Method Summary

Modifier and Type	Method and Description
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.
boolean	has(IltState state) Tests whether this state contains a given constant state (defined in a state system).
static void	InitStrategies() Sets the map and list strategies to their default values.
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.

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, getPrimaryState, 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

IltAlarmObjectState

public IltAlarmObjectState()

Creates a new IltAlarmObjectState with no alarms.

Method Detail

clone

public Object clone()

Returns a copy of this state object.

Overrides:

clone in class IltObjectState

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

InitStrategies

public static void InitStrategies()

Sets the map and list strategies to their default values.

Internal: do not use!