Index (LSST Camera Control Software - Buses Definition 2.0.2 API)

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

A

add(AgentInfo, DistributionInfo) - Method in class org.lsst.ccs.bus.messages.CCSVersions: Add a new AgentInfo, DistributionInfo pair.
add(String, Object) - Method in class org.lsst.ccs.bus.messages.KVList
addData(EncodedDataStatus, long, String, Object) - Static method in class org.lsst.ccs.bus.messages.EncodedDataStatus: Static method that adds a new EncodedDataStatus(timestamp, name, value) to the current parameter.
addPlot(String, String) - Method in class org.lsst.ccs.bus.messages.AidaPlots
addStatus(EncodedDataStatus) - Method in class org.lsst.ccs.bus.messages.EncodedDataStatus: adds another status at the end of the linked list of status sent in a single message
AgentInfo - Class in org.lsst.ccs.bus.messages
AgentInfo(String, AgentInfo.AgentType) - Constructor for class org.lsst.ccs.bus.messages.AgentInfo
AgentInfo.AgentType - Enum in org.lsst.ccs.bus.messages
AidaPlots - Class in org.lsst.ccs.bus.messages
AidaPlots() - Constructor for class org.lsst.ccs.bus.messages.AidaPlots
Alarm - Class in org.lsst.ccs.bus.messages
Alarm() - Constructor for class org.lsst.ccs.bus.messages.Alarm
AlarmClear - Class in org.lsst.ccs.bus.messages: An alarm cleared message that can be sent on the status bus
AlarmClear() - Constructor for class org.lsst.ccs.bus.messages.AlarmClear
AlarmMessage - Interface in org.lsst.ccs.bus.messages
AlarmOnStateChange - Class in org.lsst.ccs.bus.messages
AlarmOnStateChange(StateBundle, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.AlarmOnStateChange
AlarmState - Enum in org.lsst.ccs.bus.states: The Alarm State of an Agent reflects how the hardware measured quantities compare to their operational limits.

B

Bus<T extends BusMessage> - Class in org.lsst.ccs.bus.definition: Bus definitions.
BusMessage - Class in org.lsst.ccs.bus.messages: Base class for messages sent on the buses.
BusMessage() - Constructor for class org.lsst.ccs.bus.messages.BusMessage

C

CCSVersions - Class in org.lsst.ccs.bus.messages: Utility class that encapsulates all the versions of the Agents on the CCS Environment
CCSVersions() - Constructor for class org.lsst.ccs.bus.messages.CCSVersions
ChangeNotificationMessage<T extends Serializable> - Class in org.lsst.ccs.bus.messages
ChangeNotificationMessage(T, T) - Constructor for class org.lsst.ccs.bus.messages.ChangeNotificationMessage
clone() - Method in class org.lsst.ccs.bus.states.StateBundle
COMMAND - Static variable in class org.lsst.ccs.bus.definition.Bus
CommandAck - Class in org.lsst.ccs.bus.messages: Command Ack.
CommandAck(CommandRequest, String) - Constructor for class org.lsst.ccs.bus.messages.CommandAck
CommandAck(CommandRequest, Object, String) - Constructor for class org.lsst.ccs.bus.messages.CommandAck
CommandError - Class in org.lsst.ccs.bus.messages: Command Error.
CommandError(CommandRequest, Throwable, String) - Constructor for class org.lsst.ccs.bus.messages.CommandError
CommandMessage - Class in org.lsst.ccs.bus.messages: Message to be sent on the Command Bus.
CommandMessage(String, String) - Constructor for class org.lsst.ccs.bus.messages.CommandMessage
CommandMessage(String) - Constructor for class org.lsst.ccs.bus.messages.CommandMessage
CommandNack - Class in org.lsst.ccs.bus.messages: Command NACK.
CommandNack(CommandRequest, Object, String) - Constructor for class org.lsst.ccs.bus.messages.CommandNack
CommandRejectedException - Exception in org.lsst.ccs.bus.messages
CommandRejectedException(CommandNack) - Constructor for exception org.lsst.ccs.bus.messages.CommandRejectedException
CommandReply - Class in org.lsst.ccs.bus.messages: Base class for a command response.
CommandReply(CommandRequest, Object, String) - Constructor for class org.lsst.ccs.bus.messages.CommandReply
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 - Class in org.lsst.ccs.bus.messages: The result of a CommandRequest.
CommandResult(CommandRequest, Object, String) - Constructor for class org.lsst.ccs.bus.messages.CommandResult: Constructor for successful execution.
CommandResult(CommandRequest, Throwable, String) - Constructor for class org.lsst.ccs.bus.messages.CommandResult: Constructor for a CommandResult that produced an exception.
CommandState - Enum in org.lsst.ccs.bus.states: State elements that deal with command execution.
ConfigurationChangeNotification - Class in org.lsst.ccs.bus.messages
ConfigurationChangeNotification(ConfigurationInfo, ConfigurationInfo) - Constructor for class org.lsst.ccs.bus.messages.ConfigurationChangeNotification
ConfigurationInfo - Class in org.lsst.ccs.bus.messages: A Class containing the Agent's configuration information.
ConfigurationInfo(String) - Constructor for class org.lsst.ccs.bus.messages.ConfigurationInfo

D

displayName() - Method in enum org.lsst.ccs.bus.messages.AgentInfo.AgentType
DistributionInfo - Class in org.lsst.ccs.bus.messages: A Class to capture the information regarding this distribution.
DistributionInfo() - Constructor for class org.lsst.ccs.bus.messages.DistributionInfo

E

EncodedDataStatus - Class in org.lsst.ccs.bus.messages: Status with additional information.
EncodedDataStatus(long, KVList) - Constructor for class org.lsst.ccs.bus.messages.EncodedDataStatus: creates a status with a list of Key-value pairs with the same timestamp
EncodedDataStatus(KVList) - Constructor for class org.lsst.ccs.bus.messages.EncodedDataStatus: creates a status with a list of Key-value pairs with the same timestamp which is generated at creation time.
EncodedDataStatus(long, String, Object) - Constructor for class org.lsst.ccs.bus.messages.EncodedDataStatus: creates a status with a single key and value (the timestamp is also provided)
EncodedDataStatus(String, Object) - Constructor for class org.lsst.ccs.bus.messages.EncodedDataStatus: creates a status with a single key and value (the timestamp is generated)
equals(Object) - Method in class org.lsst.ccs.bus.messages.AgentInfo
equals(Object) - Method in class org.lsst.ccs.bus.messages.BusMessage
equals(Object) - Method in class org.lsst.ccs.bus.messages.DistributionInfo
equals(Object) - Method in class org.lsst.ccs.bus.messages.HeartBeatStatus
equals(Object) - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
equals(Object) - Method in class org.lsst.ccs.bus.messages.StatusMessage
equals(Object) - Method in class org.lsst.ccs.bus.states.StateBundle: MT: Commented out.

F

freeMemory - Variable in class org.lsst.ccs.bus.messages.RuntimeInfo

G

getAgents() - Method in class org.lsst.ccs.bus.messages.CCSVersions: Get the Set of AgentInfo contained in this class.
getBasicCommand() - Method in class org.lsst.ccs.bus.messages.CommandRequest
getBuildId() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getBuildJdk() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getBuildNumber() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getBuildUrl() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getCategorySet() - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
getCommand() - Method in class org.lsst.ccs.bus.messages.CommandReply
getCommandOriginatorId() - Method in class org.lsst.ccs.bus.messages.CommandReply
getCommandOriginatorId() - Method in class org.lsst.ccs.bus.messages.CommandRequest: Get the CommandOriginator Id for this CommandRequest.
getContent() - Method in class org.lsst.ccs.bus.messages.EncodedDataStatus
getContentAsList() - Method in class org.lsst.ccs.bus.messages.KeyData: returns a list of key-values that can be directly used byt a trending database: each key (the name of fields in a composite object) is prepended with the actual key of this object (if overall key is "position" you may get something like "position.x" and "position.y" as keys in the list)
getCorrelId() - Method in class org.lsst.ccs.bus.messages.CommandMessage: The correlationId of this CommandMessage.
getCrystallizedData() - Method in class org.lsst.ccs.bus.messages.KeyData: Big objects can be kept in database as Blobs.
getDataName() - Method in class org.lsst.ccs.bus.messages.MetadataStatus
getDataTimestamp() - Method in class org.lsst.ccs.bus.messages.EncodedDataStatus
getDescriptionName() - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
getDestination() - Method in class org.lsst.ccs.bus.messages.CommandMessage: The destination of the CommandMessage.
getDistributionInfo(AgentInfo) - Method in class org.lsst.ccs.bus.messages.CCSVersions: Get the DistributionInfo for a given AgentInfo.
getDistributionInfo(String) - Method in class org.lsst.ccs.bus.messages.CCSVersions: Get the DistributionInfo for a given agent by name.
getDistributionInfo() - Method in class org.lsst.ccs.bus.messages.HeartBeatStatus
getFormattedDetails() - Method in class org.lsst.ccs.bus.messages.LogMessage
getFreeMemory() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
getFullConfigurationName() - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
getKey() - Method in class org.lsst.ccs.bus.messages.KeyData
getLevel() - Method in class org.lsst.ccs.bus.messages.LogMessage
getLoggerName() - Method in class org.lsst.ccs.bus.messages.LogMessage
getMaxMemory() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
getMetadataName() - Method in class org.lsst.ccs.bus.messages.MetadataStatus
getMetadataValue() - Method in class org.lsst.ccs.bus.messages.MetadataStatus
getName() - Method in class org.lsst.ccs.bus.messages.AgentInfo
getNewValue() - Method in class org.lsst.ccs.bus.messages.ChangeNotificationMessage
getNThreads() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
getOldValue() - Method in class org.lsst.ccs.bus.messages.ChangeNotificationMessage
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.
getPair(String) - Method in class org.lsst.ccs.bus.messages.KVList: not extremely efficient way to retrieve an element
getPlot(String) - Method in class org.lsst.ccs.bus.messages.AidaPlots
getPlots() - Method in class org.lsst.ccs.bus.messages.AidaPlots
getProcessCpuLoad() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
getProject() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getRawValue() - Method in class org.lsst.ccs.bus.messages.KeyData
getReason() - Method in class org.lsst.ccs.bus.messages.CommandError: The reason for the refusal.
getReason() - Method in class org.lsst.ccs.bus.messages.CommandNack: The reason for the refusal.
getReply() - Method in class org.lsst.ccs.bus.messages.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.HeartBeatStatus
getSourceCodeRevision() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getSourceCodeUrl() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
getSourceName() - Method in class org.lsst.ccs.bus.messages.LogMessage
getState() - Method in class org.lsst.ccs.bus.messages.StatusMessage: Get the PublishedState 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: Get the current value for a given State by providing the class of the Enum representing the state.
getStatusBroadcastPeriod() - Method in class org.lsst.ccs.bus.messages.HeartBeatStatus
getSummary() - Method in class org.lsst.ccs.bus.messages.BusMessage: The summary string for this BusMessage.
getSystemCpuLoad() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
getTagForCategory(String) - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
getTagName() - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
getThreadName() - Method in class org.lsst.ccs.bus.messages.LogMessage
getTimeStamp() - Method in class org.lsst.ccs.bus.messages.BusMessage: Get the timestamp associated to this BusMessage.
getTotalMemory() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
getType() - Method in class org.lsst.ccs.bus.messages.AgentInfo
getUpdatedKey(String) - Method in class org.lsst.ccs.bus.messages.KeyData
getValue() - Method in class org.lsst.ccs.bus.messages.KeyData: returns the value of the contained object if its class is accessible to the current ClassLoader.
getVersion() - Method in class org.lsst.ccs.bus.messages.DistributionInfo

H

hasCategory(String) - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
hashCode() - Method in class org.lsst.ccs.bus.messages.AgentInfo
hashCode() - Method in class org.lsst.ccs.bus.messages.BusMessage
hashCode() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
hashCode() - Method in class org.lsst.ccs.bus.messages.HeartBeatStatus
hashCode() - Method in class org.lsst.ccs.bus.messages.RuntimeInfo
hashCode() - Method in class org.lsst.ccs.bus.messages.StatusMessage
hashCode() - Method in class org.lsst.ccs.bus.states.StateBundle
hasLocalChanges() - Method in class org.lsst.ccs.bus.messages.ConfigurationInfo
HeartBeatStatus - Class in org.lsst.ccs.bus.messages
HeartBeatStatus(int) - Constructor for class org.lsst.ccs.bus.messages.HeartBeatStatus

I

id() - Method in enum org.lsst.ccs.bus.messages.AgentInfo.AgentType
isInState(T) - Method in class org.lsst.ccs.bus.states.StateBundle: Check if this StateBundle contains a given Enum 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.
iterator() - Method in class org.lsst.ccs.bus.messages.EncodedDataStatus: helps iterating over a list of linked status message.
iterator() - Method in class org.lsst.ccs.bus.messages.KVList

K

KeyData - Class in org.lsst.ccs.bus.messages: A key-value pair.
KVList - Class in org.lsst.ccs.bus.messages
KVList(int) - Constructor for class org.lsst.ccs.bus.messages.KVList
KVList() - Constructor for class org.lsst.ccs.bus.messages.KVList
KVList(String, Object) - Constructor for class org.lsst.ccs.bus.messages.KVList

L

LOG - Static variable in class org.lsst.ccs.bus.definition.Bus
logger - Static variable in class org.lsst.ccs.bus.messages.KeyData
LogMessage - Class in org.lsst.ccs.bus.messages: Message to be sent on the Log Bus.
LogMessage(String, String, String, String, String) - Constructor for class org.lsst.ccs.bus.messages.LogMessage

M

maxMemory - Variable in class org.lsst.ccs.bus.messages.RuntimeInfo
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.
MetadataStatus - Class in org.lsst.ccs.bus.messages: A special status publishing a name/value pair on the status bus
MetadataStatus(String, String, String) - Constructor for class org.lsst.ccs.bus.messages.MetadataStatus
MetadataStatus(String, String, String, long) - Constructor for class org.lsst.ccs.bus.messages.MetadataStatus

N

nThreads - Variable in class org.lsst.ccs.bus.messages.RuntimeInfo

O

OperationalState - Enum in org.lsst.ccs.bus.states: The Operational State of an Agent.
ordinal() - Method in class org.lsst.ccs.bus.definition.Bus
org.lsst.ccs.bus.definition - package org.lsst.ccs.bus.definition: This package deals with standard messages for the CCS buses.
org.lsst.ccs.bus.messages - package org.lsst.ccs.bus.messages
org.lsst.ccs.bus.states - package org.lsst.ccs.bus.states
osBean - Static variable in class org.lsst.ccs.bus.messages.RuntimeInfo

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.
processCpuLoad - Variable in class org.lsst.ccs.bus.messages.RuntimeInfo

R

runtime - Static variable in class org.lsst.ccs.bus.messages.RuntimeInfo
RuntimeInfo - Class in org.lsst.ccs.bus.messages: A Class to capture the Health of the running process.
RuntimeInfo() - Constructor for class org.lsst.ccs.bus.messages.RuntimeInfo

S

setCommandOriginatorId(String) - Method in class org.lsst.ccs.bus.messages.CommandRequest: Get the CommandOriginator Id for this CommandRequest.
setNext(EncodedDataStatus) - Method in class org.lsst.ccs.bus.messages.EncodedDataStatus: links another status next to this one (for sending a batch of status in a single message)
setOriginAgentInfo(AgentInfo) - Method in class org.lsst.ccs.bus.messages.BusMessage: Sets the origin for this BusMessage.
setState(StateBundle) - Method in class org.lsst.ccs.bus.messages.StatusMessage: Set the StateBundle object containing the Agent's internal state at the moment the StatusMessage was published.
setState(T) - Method in class org.lsst.ccs.bus.states.StateBundle: Set the value of a state in the form of an Enum value.
setSummary(String) - Method in class org.lsst.ccs.bus.messages.BusMessage: Set the summary for this BusMessage.
state - Variable in class org.lsst.ccs.bus.messages.StatusMessage
StateBundle - Class in org.lsst.ccs.bus.states: A class to collect any number of State information.
StateBundle(Enum...) - Constructor for class org.lsst.ccs.bus.states.StateBundle: Construct a StateBundle from a set of states.
StateChangeNotification - Class in org.lsst.ccs.bus.messages: A ChangeNotificationMessage for State changes.
StateChangeNotification(StateBundle, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StateChangeNotification
STATUS - Static variable in class org.lsst.ccs.bus.definition.Bus
StatusMessage - Class in org.lsst.ccs.bus.messages: Message to be sent on the Status Bus.
StatusMessage() - Constructor for class org.lsst.ccs.bus.messages.StatusMessage
systemCpuLoad - Variable in class org.lsst.ccs.bus.messages.RuntimeInfo

T

toString() - Method in class org.lsst.ccs.bus.definition.Bus
toString() - Method in class org.lsst.ccs.bus.messages.AgentInfo
toString() - Method in class org.lsst.ccs.bus.messages.Alarm
toString() - Method in class org.lsst.ccs.bus.messages.AlarmClear
toString() - Method in class org.lsst.ccs.bus.messages.CCSVersions
toString() - Method in class org.lsst.ccs.bus.messages.CommandAck
toString() - Method in exception org.lsst.ccs.bus.messages.CommandRejectedException
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.ConfigurationInfo
toString() - Method in class org.lsst.ccs.bus.messages.DistributionInfo
toString() - Method in class org.lsst.ccs.bus.messages.EncodedDataStatus
toString() - Method in class org.lsst.ccs.bus.messages.KeyData
toString() - Method in class org.lsst.ccs.bus.messages.LogMessage: returns the "formatted details"
toString() - Method in class org.lsst.ccs.bus.messages.MetadataStatus
toString() - Method in class org.lsst.ccs.bus.messages.StatusMessage
toString() - Method in class org.lsst.ccs.bus.states.StateBundle
totalMemory - Variable in class org.lsst.ccs.bus.messages.RuntimeInfo

V

valueOf(String) - Static method in class org.lsst.ccs.bus.definition.Bus: emulates the valueOf method of enums
valueOf(String) - Static method in enum org.lsst.ccs.bus.messages.AgentInfo.AgentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.lsst.ccs.bus.states.AlarmState: 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.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 class org.lsst.ccs.bus.definition.Bus: emulates the values method of enums
values() - Static method in enum org.lsst.ccs.bus.messages.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.states.AlarmState: 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.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.

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