public final class ControlSystemChannelStatus extends Object
ControlSystemChannel
. Instances of this class can be
created through the connected()
, disconnected()
, and
error(Throwable)
methods.Modifier and Type | Class and Description |
---|---|
static class |
ControlSystemChannelStatus.State
State of a control-system channel.
|
Modifier and Type | Method and Description |
---|---|
static ControlSystemChannelStatus |
connected()
Returns a status that indicates that the channel is connected.
|
static ControlSystemChannelStatus |
disabled()
Returns a status that indicates that archiving for the channel has been
temporarily disabled.
|
static ControlSystemChannelStatus |
disconnected()
Returns a status that indicates that the channel is disconnected.
|
boolean |
equals(Object obj) |
static ControlSystemChannelStatus |
error(Throwable error)
Returns a status that indicates that the channel is in the error state.
|
Throwable |
getError()
Returns the error associated with the channel status.
|
ControlSystemChannelStatus.State |
getState()
Returns the channel's state.
|
int |
hashCode() |
String |
toString() |
public static ControlSystemChannelStatus connected()
public static ControlSystemChannelStatus disabled()
Returns a status that indicates that archiving for the channel has been temporarily disabled. This means that the control-system support is operating correctly, but has decided that samples should currently not be archived. Typically, such a decision will be made based on a dynamic condition (e.g. a certain flag being set on the channel's server or the state of another channel).
Unlike a channel that has been disabled in its configuration, a channel that has been disabled by the control-system support can become active at any time without user intervention.
public static ControlSystemChannelStatus disconnected()
public static ControlSystemChannelStatus error(Throwable error)
error
- optional error associated with the problem. May be
null
.public Throwable getError()
ControlSystemChannelStatus.State.ERROR
state, this method always returns
null. Even if the channel is in the error state, the error might object
might be null.null
if
this information is not available.public ControlSystemChannelStatus.State getState()
null
.Copyright © 2011–2017 aquenos GmbH. All rights reserved.