A B C D E G H I K L M O P R S T V W

A

add(AgentInfo, DistributionInfo) - Method in class org.lsst.ccs.bus.data.CCSVersions

Add a new AgentInfo, DistributionInfo pair.

addAlarm(String, String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

addAlertInstance(AlertState, Alert, long, String) - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Add a new instance of this Alert.

addAlertInstance(AlertState, Alert, long, String, int) - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Add a new instance of this Alert.

addChannel(MonitorChan) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

addData(String, Serializable) - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Add a key-value pair to this KeyValueDataList by assigning it the timestamp of the KeyDataList.

addData(String, Serializable, KeyValueData.KeyValueDataType) - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Add a key-value pair to this KeyValueDataList by assigning it the timestamp of the KeyDataList.

addData(String, Serializable, long) - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Add a key-value pair with a timestamp to this KeyValueDataList.

addData(String, Serializable, long, KeyValueData.KeyValueDataType) - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Add a key-value pair with a timestamp to this KeyValueDataList.

addData(KeyValueData) - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Add a KeyValueData object to the KeyValueDataList.

addPage(Integer, String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

AgentInfo - Class in org.lsst.ccs.bus.data

A class to encapsulate an agent's name and type.

AgentInfo(String, AgentInfo.AgentType) - Constructor for class org.lsst.ccs.bus.data.AgentInfo

The base constructor of an AgentInfo.

AgentInfo(String, AgentInfo.AgentType, Properties) - Constructor for class org.lsst.ccs.bus.data.AgentInfo

The base constructor of an AgentInfo.

AgentInfo.AgentType - Enum in org.lsst.ccs.bus.data

Enumeration of known agent types.

AgentState - Interface in org.lsst.ccs.bus.states

Marker interface to distinguish internal states of an Agent.

Alert - Class in org.lsst.ccs.bus.data

Base class for all Alerts.

Alert(String, String) - Constructor for class org.lsst.ccs.bus.data.Alert

Base constructor for all Alerts.

AlertState - Enum in org.lsst.ccs.bus.states

The Alert State of an Agent reflects how the hardware measured quantities compare to their operational limits.

B

Bus - Enum in org.lsst.ccs.bus.definition

Enumeration of CCS Buses.

BusMessage<T extends Serializable,D> - Class in org.lsst.ccs.bus.messages

Base class for messages sent on the buses.

BusMessage(T) - Constructor for class org.lsst.ccs.bus.messages.BusMessage

Build a BusMessage from the provided Object.

C

CCSVersions - Class in org.lsst.ccs.bus.data

Utility class that encapsulates all the versions of the Agents on the CCS Environment

CCSVersions() - Constructor for class org.lsst.ccs.bus.data.CCSVersions

clone() - Method in class org.lsst.ccs.bus.states.StateBundle

ClusterAlert - Class in org.lsst.ccs.bus.data

An alert standing for CCS version incompatibilities detected on the buses.

ClusterAlert(String, String) - Constructor for class org.lsst.ccs.bus.data.ClusterAlert

CommandAck - Class in org.lsst.ccs.bus.messages

Command ACK.

CommandAck(CommandRequest, Duration) - Constructor for class org.lsst.ccs.bus.messages.CommandAck

CommandAcks are constructed from the corresponding CommandRequest.

CommandMessage<T extends Serializable,D> - Class in org.lsst.ccs.bus.messages

Superclass for all messages sent on the Command Bus.

CommandMessage(String, UUID, T) - Constructor for class org.lsst.ccs.bus.messages.CommandMessage

Default CommandMessage constructor.

CommandNack<T extends Serializable> - Class in org.lsst.ccs.bus.messages

Command NACK.

CommandNack(CommandRequest, T) - Constructor for class org.lsst.ccs.bus.messages.CommandNack

CommandNacks are built from the corresponding CommandRequest and the reason for which the command will not be carried out.

CommandReply<T extends Serializable> - Class in org.lsst.ccs.bus.messages

Base class for a command reply.

CommandReply(CommandRequest, T) - Constructor for class org.lsst.ccs.bus.messages.CommandReply

Main CommandReply constructor.

CommandRequest - Class in org.lsst.ccs.bus.messages

Wrapper class to send a BasicCommand over the Command bus; the BasicCommand is either provided as an object or created internally from a String representation: e.g.

CommandRequest(String, String, Object...) - Constructor for class org.lsst.ccs.bus.messages.CommandRequest

Create a BasicCommandMessage from a string representation of a command: e.g.

CommandRequest(String, String) - Constructor for class org.lsst.ccs.bus.messages.CommandRequest

Create a BasicCommandMessage from a string representation of a command: e.g.

CommandRequest(String, BasicCommand) - Constructor for class org.lsst.ccs.bus.messages.CommandRequest

Create a BasicCommandMessage from an existing BasicCommand.

CommandResult<T extends Serializable> - Class in org.lsst.ccs.bus.messages

The result of a CommandRequest.

CommandResult(CommandRequest, T) - Constructor for class org.lsst.ccs.bus.messages.CommandResult

Constructor for a CommandResult.

CommandState - Enum in org.lsst.ccs.bus.states

Agent State with respect to command execution.

ConfigurationInfo - Class in org.lsst.ccs.bus.data

A Class containing the Agent's configuration information.

ConfigurationInfo(ConfigurationState, String) - Constructor for class org.lsst.ccs.bus.data.ConfigurationInfo

ConfigurationInfo(ConfigurationState, String, Map<String, String>, Map<String, Boolean>, List<ConfigurationParameterInfo>) - Constructor for class org.lsst.ccs.bus.data.ConfigurationInfo

ConfigurationInfo(ConfigurationState, String, Map<String, String>, Map<String, Boolean>, List<ConfigurationParameterInfo>, List<String>) - Constructor for class org.lsst.ccs.bus.data.ConfigurationInfo

ConfigurationParameterInfo - Class in org.lsst.ccs.bus.data

Represents the state of a given parameter.

ConfigurationParameterInfo(String, String, String, boolean, String, String, boolean, String) - Constructor for class org.lsst.ccs.bus.data.ConfigurationParameterInfo

ConfigurationParameterInfo(String, String, String, String, String, boolean, String) - Constructor for class org.lsst.ccs.bus.data.ConfigurationParameterInfo

Deprecated.

ConfigurationState - Enum in org.lsst.ccs.bus.states

The Configuration state of a subsystem reflects the state of its set of configurable parameters.

D

diffState(StateBundle) - Method in class org.lsst.ccs.bus.states.StateBundle

Finds what has changed.

displayName() - Method in enum org.lsst.ccs.bus.data.AgentInfo.AgentType

Get the name of the AgentType for display purposes.

DistributionInfo - Class in org.lsst.ccs.bus.data

A Class to capture the information regarding this distribution.

DistributionInfo() - Constructor for class org.lsst.ccs.bus.data.DistributionInfo

E

EmbeddedObjectDeserializationException - Exception in org.lsst.ccs.bus.messages

An exception occurring during the deserialization of the serialized embedded object of a BusMessage.

EmbeddedObjectDeserializationException(String, Throwable) - Constructor for exception org.lsst.ccs.bus.messages.EmbeddedObjectDeserializationException

encodeObject(T) - Method in class org.lsst.ccs.bus.messages.BusMessage

Subclasses must provide a specific implementation of the encoding process.

encodeObject(T) - Method in class org.lsst.ccs.bus.messages.CommandReply

encodeObject(BasicCommand) - Method in class org.lsst.ccs.bus.messages.CommandRequest

encodeObject(String) - Method in class org.lsst.ccs.bus.messages.LogMessage

encodeObject(String[]) - Method in class org.lsst.ccs.bus.messages.StatusClearedAlert

encodeObject(ConfigurationInfo) - Method in class org.lsst.ccs.bus.messages.StatusConfigurationInfo

encodeObject(KeyValueData) - Method in class org.lsst.ccs.bus.messages.StatusData

encodeObject(T) - Method in class org.lsst.ccs.bus.messages.StatusEnum

encodeObject(Serializable) - Method in class org.lsst.ccs.bus.messages.StatusHeartBeat

encodeObject(Alert) - Method in class org.lsst.ccs.bus.messages.StatusRaisedAlert

encodeObject(StateBundle) - Method in class org.lsst.ccs.bus.messages.StatusStateChangeNotification

equals(Object) - Method in class org.lsst.ccs.bus.data.AgentInfo

equals(Object) - Method in class org.lsst.ccs.bus.data.Alert

equals(Object) - Method in class org.lsst.ccs.bus.states.StateBundle

G

getAccumulatedNumberOfInstances() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the accumulated number of times this alert was raised.

getAgentProperty(String) - Method in class org.lsst.ccs.bus.data.AgentInfo

Get the value of the property for this Agent.

getAgents() - Method in class org.lsst.ccs.bus.data.CCSVersions

Get the Set of AgentInfo contained in this class.

getAlarms() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

getAlertId() - Method in class org.lsst.ccs.bus.data.Alert

Get the Alert id

getAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance

The AlertState at which the RaisedAlertInstance was raised.

getAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary

Get the overall AlertState for this RaisedAlarm summary object .

getAllParameterInfo() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Returns a list of ConfigurationParameterInfo.

getAllRaisedAlertHistories() - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary

Get the set of raised Alerts.

getBasicCommand() - Method in class org.lsst.ccs.bus.messages.CommandRequest

Utility method to get the embedded BasicCommand.

getBuildId() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getBuildJdk() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getBuildNumber() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getBuildUrl() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getCategoryName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

The category the parameter belongs to.

getCategorySet() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

getCause() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance

What caused this alert to be raised.

getCause() - Method in class org.lsst.ccs.bus.messages.StatusRaisedAlert

Get the String explaining what caused the Alert.

getChannels() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

getClassName() - Method in class org.lsst.ccs.bus.messages.BusMessage

Get the class name of the embedded object.

getClearAlertIds() - Method in class org.lsst.ccs.bus.messages.StatusClearedAlert

Get the String array of the alertIds that have been cleared.

getComponentName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

Returns the name of the component the parameter represented by this object belongs to.

getConfigNameForCategory(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

getConfigurationInfo() - Method in class org.lsst.ccs.bus.messages.StatusConfigurationInfo

Get the ConfigurationInfo object contained in this message.

getConfigurationName() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

getConfigurationState() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

getConfiguredValue() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

The configured value for this parameter, i.e the value defined by the last configuration loading.

getCorrelationId() - Method in class org.lsst.ccs.bus.messages.CommandMessage

The correlationId of this CommandMessage.

getCount() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance

The number of time this alert was raised.

getCurrentValue() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

The current value for this parameter.

getCurrentValueForParameter(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Return the current value of a given configurable parameter

getCurrentValuesFor(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Returns the current value of each parameter that belong to the specified configurable component.

getCurrentValuesForCategory(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Returns the current value of each parameter that belong to the specified category.

getDataKey() - Method in class org.lsst.ccs.bus.messages.StatusSubsystemData

Get the Key of the embedded object.

getDescription() - Method in class org.lsst.ccs.bus.data.Alert

Get the Alert description

getDescription() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

getDescription() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getDescriptionName() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Returns the subsystem description name, ie the name of the description file the subsystem is started with.

getDestination() - Method in class org.lsst.ccs.bus.messages.CommandMessage

The destination of the CommandMessage.

getDistributionInfo(AgentInfo) - Method in class org.lsst.ccs.bus.data.CCSVersions

Get the DistributionInfo for a given AgentInfo.

getDistributionInfo(String) - Method in class org.lsst.ccs.bus.data.CCSVersions

Get the DistributionInfo for a given agent by name.

getEncodedData() - Method in class org.lsst.ccs.bus.messages.BusMessage

Get the Encoded version of the embedded Object.

getEncodedData() - Method in class org.lsst.ccs.bus.messages.CommandReply

getEncodedData() - Method in class org.lsst.ccs.bus.messages.LogMessage

getEncodedData() - Method in class org.lsst.ccs.bus.messages.StatusData

getFormat() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getFormattedDetails() - Method in class org.lsst.ccs.bus.messages.LogMessage

The formatted version of the logged message.

getFreeMemory() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the JVM free memory in bytes

getGoodChans() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorState

getHighAlarm() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getHighestAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the highest AlertState raised for this Alert.

getHighLimit() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getHighLimitChange() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorState

getHighWarning() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getInternalStates() - Method in class org.lsst.ccs.bus.states.StateBundle

Gets string representations of the internal states.

getKey() - Method in class org.lsst.ccs.bus.data.KeyValueData

Get the key.

getLastModified() - Method in class org.lsst.ccs.bus.states.StateBundle

Get the Instant of the last time the StateBundle was modified.

getLatestAlert() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the original Alert that was raised.

getLatestAlertCause() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Gets the latest cause of this Alert.

getLatestAlertInstance() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Gets the latest raised instance of this alert.

getLatestAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the latest AlertState of this Alert.

getLatestAlertTimestamp() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the latest CCS timestamp of this Alert.

getLatestChanges() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Returns a list of the recent changes caused by the If a single change is processed, the returned list contains this change only.

getLevel() - Method in class org.lsst.ccs.bus.messages.LogMessage

The level (or severity) of the LogMessage.

getListOfKeyValueData() - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Get the list of KeyValueData contained in this object.

getListOfKeyValueData(KeyValueData.KeyValueDataType) - Method in class org.lsst.ccs.bus.data.KeyValueDataList

Get the list of KeyValueData contained in this object for a given type.

getLoggerName() - Method in class org.lsst.ccs.bus.messages.LogMessage

Get the name of the logger used to record the LogMessage.

getLowAlarm() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getLowLimit() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getLowLimitChange() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorState

getLowWarning() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getMaxMemory() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the maximum memory allocated for the JVM in bytes

getMonitorFullState() - Method in class org.lsst.ccs.subsystem.monitor.data.MonMainFullState

getMonitorState() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

getMonMainState() - Method in class org.lsst.ccs.subsystem.monitor.data.MonMainFullState

getName() - Method in class org.lsst.ccs.bus.data.AgentInfo

The Agent's name on the Buses.

getName() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getNewState() - Method in class org.lsst.ccs.bus.messages.StatusStateChangeNotification

Get the new state of the Agent.

getNThreads() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the number of threads currently used.

getNumberOfInstances() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the number of times this Alert was raised.

getObject() - Method in class org.lsst.ccs.bus.messages.BusMessage

Get the original version of the embedded Object.

getOldState() - Method in class org.lsst.ccs.bus.messages.StatusStateChangeNotification

Get the old state of the Agent.

getOnlineChans() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorState

getOriginAgentInfo() - Method in class org.lsst.ccs.bus.messages.BusMessage

The Origin of the BusMessage, the bus registration name of the Agent from which it originated.

getPage() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getPages() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

getParameterInfoGroupByCategory(List<ConfigurationParameterInfo>) - Static method in class org.lsst.ccs.bus.data.ConfigurationInfo

Groups the ConfigurationParameterInfo objects of the input list by the category they belong to.

getParameterInfoGroupByComponent(List<ConfigurationParameterInfo>) - Static method in class org.lsst.ccs.bus.data.ConfigurationInfo

Groups the ConfigurationParameterInfo objects of the input list by the component they belong to.

getParameterName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

Returns the name of the parameter represented by this object.

getPathName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

The Path name of the parameter.

getProcessCpuLoad() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the process current CPU load.

getProject() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getRaisedAlert(String) - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary

Get a RaisedAlert for a given id.

getRaisedAlert() - Method in class org.lsst.ccs.bus.messages.StatusRaisedAlert

Get the RaisedAlert contained in this message.

getRaisedAlertInstancesList() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

Get the full history of RaisedAlertInstances for this Alert.

getRaisedAlertSummary() - Method in class org.lsst.ccs.bus.messages.StatusAlert

getReason() - Method in class org.lsst.ccs.bus.messages.CommandNack

The reason for the refusal.

getReceiver() - Method in class org.lsst.ccs.bus.data.ClusterAlert

The name of the agent that received a message which is incompatible with the local CCS version.

getReply() - Method in class org.lsst.ccs.bus.messages.CommandReply

Utility method to get the reply contained in this CommandReply.

getResult() - Method in class org.lsst.ccs.bus.messages.CommandResult

Get the result of the CommandRequest execution.

getRuntimeInfo() - Method in class org.lsst.ccs.bus.messages.StatusRuntimeInfo

Get the RuntimeInfo object contained in this message.

getSender() - Method in class org.lsst.ccs.bus.data.ClusterAlert

The name of the agent that sent a message which is incompatible with the local CCS version.

getSourceCodeRevision() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getSourceCodeUrl() - Method in class org.lsst.ccs.bus.data.DistributionInfo

getSourceName() - Method in class org.lsst.ccs.bus.messages.LogMessage

Get the source of the LogMessage.

getState() - Method in class org.lsst.ccs.bus.messages.StatusMessage

Get the published State object that contains the Agent's internal state at the moment the StatusMessage was published.

getState(Class<T>) - Method in class org.lsst.ccs.bus.states.StateBundle

Returns the current value for the specified State.

getStatusBroadcastPeriod() - Method in class org.lsst.ccs.bus.messages.StatusHeartBeat

Get the broadcast period in milliseconds.

getSubsystemData() - Method in class org.lsst.ccs.bus.messages.StatusSubsystemData

Get the embedded subsystem data.

getSystemCpuLoad() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the system CPU load.

getThreadName() - Method in class org.lsst.ccs.bus.messages.LogMessage

Get the name of the thread on which the LogMessage originated.

getTickMillis() - Method in class org.lsst.ccs.subsystem.monitor.data.MonMainState

getTimeout() - Method in class org.lsst.ccs.bus.messages.CommandAck

Returns the timeout value for the command suggested by the command target.

getTimestamp() - Method in class org.lsst.ccs.bus.data.KeyValueData

Get the timestamp associated with the key-value pair.

getTimestamp() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance

The CCS timestamp of when the RaisedAlertInstance was raised.

getTimeStamp() - Method in class org.lsst.ccs.bus.messages.BusMessage

Get the timestamp in CCS milliseconds of when the message was created.

getTotalMemory() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the total memory currently used by the JVM in bytes

getType() - Method in class org.lsst.ccs.bus.data.AgentInfo

The Agent's AgentType.

getType() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

Return the type of the parameter.

getType() - Method in class org.lsst.ccs.bus.data.KeyValueData

Get the KeyValueData type.

getUnits() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getUptime() - Method in class org.lsst.ccs.bus.data.RuntimeInfo

Get the Agent's uptime in milliseconds.

getValue() - Method in class org.lsst.ccs.bus.data.KeyValueData

Get the value embedding in this object.

getValue() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

getVersion() - Method in class org.lsst.ccs.bus.data.DistributionInfo

H

hasAgentProperty(String) - Method in class org.lsst.ccs.bus.data.AgentInfo

Check if a given property is set for this Agent.

hasCategory(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Tests if category is one of the subsystem parameter categories.

hasChanges() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

hasChangesForCategory(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

Returns true if there are unsaved changes for the specified category.

hashCode() - Method in class org.lsst.ccs.bus.data.AgentInfo

hashCode() - Method in class org.lsst.ccs.bus.data.Alert

hashCode() - Method in class org.lsst.ccs.bus.states.StateBundle

I

isDirty() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

Boolean indicating if this parameter has been changed to a value and has not been saved yet.

isFinal() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

isInState(T) - Method in class org.lsst.ccs.bus.states.StateBundle

Check if this StateBundle contains the specified state.

isInState(StateBundle) - Method in class org.lsst.ccs.bus.states.StateBundle

Check if this StateBundle is in all the states of a given StateBundle.

isLegal(StateBundle) - Static method in interface org.lsst.ccs.bus.states.AgentState

Returns true if Agent internal states in the specified bundle are consistent.

isLegal(StateBundle, StateBundle) - Static method in interface org.lsst.ccs.bus.states.AgentState

Returns true if the transition between Agent internal states specified by the two bundles is allowed.

iterator() - Method in class org.lsst.ccs.bus.data.KeyValueDataList

K

KEY - Static variable in class org.lsst.ccs.subsystem.monitor.data.MonitorState

KEY - Static variable in class org.lsst.ccs.subsystem.monitor.data.MonMainState

KeyValueData - Class in org.lsst.ccs.bus.data

Generic Data class for Key-Value pairs.

KeyValueData(String, Serializable, long, KeyValueData.KeyValueDataType) - Constructor for class org.lsst.ccs.bus.data.KeyValueData

Build a KeyValueData object providing the name and the value for the key-value pair and the timestamp in which this data was accumulated and their type.

KeyValueData(String, Serializable, long) - Constructor for class org.lsst.ccs.bus.data.KeyValueData

Build a KeyValueData object providing the name and the value for the key-value pair and the timestamp in which this data was accumulated.

KeyValueData(String, Serializable) - Constructor for class org.lsst.ccs.bus.data.KeyValueData

Build a KeyValueData object providing the name and the value for the key-value pair.

KeyValueData.KeyValueDataType - Enum in org.lsst.ccs.bus.data

KeyValueDataList - Class in org.lsst.ccs.bus.data

An object designed to group together KeyValueData objects before publication on the Status bus.

KeyValueDataList() - Constructor for class org.lsst.ccs.bus.data.KeyValueDataList

Create a KeyValueDataList without a key or a timestamp.

KeyValueDataList(String) - Constructor for class org.lsst.ccs.bus.data.KeyValueDataList

Create a KeyValueDataList with a key.

KeyValueDataList(String, long) - Constructor for class org.lsst.ccs.bus.data.KeyValueDataList

Create a KeyValueDataList with a key and a time stamp.

KeyValueDataList(long) - Constructor for class org.lsst.ccs.bus.data.KeyValueDataList

Create a KeyValueDataList with a time stamp.

L

LogMessage - Class in org.lsst.ccs.bus.messages

Log message to be sent on Log bus.

LogMessage(String, String, String, String, String) - Constructor for class org.lsst.ccs.bus.messages.LogMessage

LogMessage constructor.

M

mergeState(StateBundle) - Method in class org.lsst.ccs.bus.states.StateBundle

Merge the content of two StateBundle objects returning an updated cloned version of the original StateBundle object.

MonitorChan - Class in org.lsst.ccs.subsystem.monitor.data

Contains the description of a monitoring data channel

MonitorChan(String, String, String, String, int, double, double, String, double, double, String, double) - Constructor for class org.lsst.ccs.subsystem.monitor.data.MonitorChan

MonitorChan(String, String, String, String, double, String, double, String, double) - Constructor for class org.lsst.ccs.subsystem.monitor.data.MonitorChan

MonitorFullState - Class in org.lsst.ccs.subsystem.monitor.data

Contains a description of the full monitoring state.

MonitorFullState() - Constructor for class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

MonitorState - Class in org.lsst.ccs.subsystem.monitor.data

Contains the state of the monitoring system.

MonitorState(BitSet, BitSet, BitSet, BitSet) - Constructor for class org.lsst.ccs.subsystem.monitor.data.MonitorState

MonMainFullState - Class in org.lsst.ccs.subsystem.monitor.data

Contains information describing the full monitor-only system state.

MonMainFullState(MonMainState, MonitorFullState) - Constructor for class org.lsst.ccs.subsystem.monitor.data.MonMainFullState

MonMainState - Class in org.lsst.ccs.subsystem.monitor.data

Contains the state of a monitor-only subsystem

MonMainState(int) - Constructor for class org.lsst.ccs.subsystem.monitor.data.MonMainState

O

OperationalState - Enum in org.lsst.ccs.bus.states

The Operational State of an Agent.

org.lsst.ccs.bus.annotations - package org.lsst.ccs.bus.annotations

org.lsst.ccs.bus.data - package org.lsst.ccs.bus.data

This package defines all the public data sent on the CCS buses via messages defined in package org.lsst.ccs.bus.messages.

org.lsst.ccs.bus.definition - package org.lsst.ccs.bus.definition

This package defines the CCS buses.

org.lsst.ccs.bus.messages - package org.lsst.ccs.bus.messages

This package defines all the standard messages for the CCS buses.

org.lsst.ccs.bus.states - package org.lsst.ccs.bus.states

org.lsst.ccs.subsystem.monitor.data - package org.lsst.ccs.subsystem.monitor.data

P

PhaseState - Enum in org.lsst.ccs.bus.states

The Phase State Diagram reflects the stages of an Agent's life cycle, from when it starts to when it shuts down.

R

RaisedAlertHistory - Class in org.lsst.ccs.bus.data

A history of alerts for a specific alert ID.

RaisedAlertHistory() - Constructor for class org.lsst.ccs.bus.data.RaisedAlertHistory

The main constructor of the RaisedAlert.

RaisedAlertInstance - Class in org.lsst.ccs.bus.data

This class represents an instance when an Alert was raised.

raisedAlerts - Variable in class org.lsst.ccs.bus.data.RaisedAlertSummary

RaisedAlertSummary - Class in org.lsst.ccs.bus.data

A summary of the alerts that have been raised by a Subsystem.

RaisedAlertSummary() - Constructor for class org.lsst.ccs.bus.data.RaisedAlertSummary

Empty constructor.

RaisedAlertSummary(RaisedAlertSummary) - Constructor for class org.lsst.ccs.bus.data.RaisedAlertSummary

Copy constructor for sending over the buses.

RuntimeInfo - Class in org.lsst.ccs.bus.data

A Class to capture the Health of the running process.

RuntimeInfo() - Constructor for class org.lsst.ccs.bus.data.RuntimeInfo

RuntimeInfo(int) - Constructor for class org.lsst.ccs.bus.data.RuntimeInfo

S

setDescription(String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setFormat(String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setHighAlarm(String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setHighLimit(double) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setHighWarning(double) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setLowAlarm(String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setLowLimit(double) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setLowWarning(double) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setMonitorState(MonitorState) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorFullState

setName(String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setOriginAgentInfo(AgentInfo) - Method in class org.lsst.ccs.bus.messages.BusMessage

Sets the origin for this BusMessage.

setPage(int) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setState(Enum) - Method in class org.lsst.ccs.bus.states.StateBundle

Sets the specified state to the bundle, replacing any previous state of the same type.

setState(Enum...) - Method in class org.lsst.ccs.bus.states.StateBundle

Sets specified states to the bundle, replacing any previous states of the same types.

setUnits(String) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

setValue(double) - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorChan

SkipEncoding - Annotation Type in org.lsst.ccs.bus.annotations

Annotation for classes or fields that are not to be encoded.

StateBundle - Class in org.lsst.ccs.bus.states

Contains a set of subsystem states, each represented by Enum.

StateBundle(Enum...) - Constructor for class org.lsst.ccs.bus.states.StateBundle

Constructs a StateBundle from a set of states.

StatusAlert<T extends Serializable,D> - Class in org.lsst.ccs.bus.messages

Base class for Alert raising and clearing status.

StatusClearedAlert - Class in org.lsst.ccs.bus.messages

Status message sent when Alerts are cleared.

StatusClearedAlert(String[], StateBundle, RaisedAlertSummary) - Constructor for class org.lsst.ccs.bus.messages.StatusClearedAlert

Build a StatusClearAlert from the provided String array and the RaisedAlertSummary of the subsystem.

StatusConfigurationInfo - Class in org.lsst.ccs.bus.messages

A status message containing a ConfigurationInfo object.

StatusConfigurationInfo(ConfigurationInfo, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusConfigurationInfo

Create a StatusConfigurationInfo message by providing the state of the agent and the ConfigurationInfo object to be sent.

StatusData - Class in org.lsst.ccs.bus.messages

Base class for all status messages containing data that is meant to be stored in the trending database.

StatusData(KeyValueData, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusData

Build a StatusMessage from the provided Object.

StatusEnum<T extends Enum<T>> - Class in org.lsst.ccs.bus.messages

Status message containing an Enum, encoded as a String..

StatusEnum(T, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusEnum

StatusHeartBeat - Class in org.lsst.ccs.bus.messages

Heartbeat status message.

StatusHeartBeat(int, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusHeartBeat

StatusMessage<T extends Serializable,D> - Class in org.lsst.ccs.bus.messages

Base class for all messages sent on the Status Bus.

StatusMessage(T, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusMessage

Build a StatusMessage from the provided Object.

StatusRaisedAlert - Class in org.lsst.ccs.bus.messages

Base class for all status messages containing an RaisedAlert.

StatusRaisedAlert(Alert, String, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusRaisedAlert

StatusRaisedAlert(Alert, String, StateBundle, RaisedAlertSummary) - Constructor for class org.lsst.ccs.bus.messages.StatusRaisedAlert

Build a StatusAlert from the provided RaisedAlert.

StatusRuntimeInfo - Class in org.lsst.ccs.bus.messages

A status message containing a RuntimeInfo object.

StatusRuntimeInfo(RuntimeInfo, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusRuntimeInfo

Create a StatusRuntimeInfo message by providing the state of the agent.

StatusStateChangeNotification - Class in org.lsst.ccs.bus.messages

A StatusChangeNotification for State changes.

StatusStateChangeNotification(StateBundle, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusStateChangeNotification

Create a StatusStateChangeNotification object.

StatusSubsystemData - Class in org.lsst.ccs.bus.messages

Base class for all status messages containing data that is private to the sender Subsystem.

StatusSubsystemData(KeyValueData, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusSubsystemData

Build a StatusMessage from the provided Object.

T

toString() - Method in class org.lsst.ccs.bus.data.AgentInfo

toString() - Method in class org.lsst.ccs.bus.data.Alert

toString() - Method in class org.lsst.ccs.bus.data.CCSVersions

toString() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo

toString() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo

toString() - Method in class org.lsst.ccs.bus.data.DistributionInfo

toString() - Method in class org.lsst.ccs.bus.data.KeyValueData

toString() - Method in class org.lsst.ccs.bus.data.KeyValueDataList

toString() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory

toString() - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary

toString() - Method in class org.lsst.ccs.bus.messages.BusMessage

toString() - Method in class org.lsst.ccs.bus.messages.CommandAck

toString() - Method in class org.lsst.ccs.bus.messages.CommandRequest

toString() - Method in class org.lsst.ccs.bus.messages.CommandResult

toString() - Method in class org.lsst.ccs.bus.messages.LogMessage

returns the "formatted details"

toString() - Method in class org.lsst.ccs.bus.messages.StatusMessage

toString() - Method in class org.lsst.ccs.bus.states.StateBundle

toString() - Method in class org.lsst.ccs.subsystem.monitor.data.MonitorState

toString() - Method in class org.lsst.ccs.subsystem.monitor.data.MonMainState

V

valueOf(String) - Static method in enum org.lsst.ccs.bus.data.AgentInfo.AgentType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.data.KeyValueData.KeyValueDataType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.definition.Bus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.states.AlertState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.states.CommandState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.states.ConfigurationState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.states.OperationalState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.bus.states.PhaseState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.lsst.ccs.bus.data.AgentInfo.AgentType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.data.KeyValueData.KeyValueDataType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.definition.Bus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.states.AlertState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.states.CommandState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.states.ConfigurationState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.states.OperationalState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.bus.states.PhaseState

Returns an array containing the constants of this enum type, in the order they are declared.

W

wasSuccessful() - Method in class org.lsst.ccs.bus.messages.CommandResult

Was the execution of the CommandRequest successful?

A B C D E G H I K L M O P R S T V W