public enum ChannelAccessValueType extends Enum<ChannelAccessValueType>
ChannelAccessValueFactory.createValue(ChannelAccessValueType, Charset)
method.ChannelAccessValue
Enum Constant and Description |
---|
DBR_CHAR
Type representing a simple byte value.
|
DBR_CLASS_NAME
Types used to retrieve information about the underlying record type of a
channel.
|
DBR_CTRL_CHAR
Type representing a simple byte value with alarm information, engineering
units, and alarm, control, and display limits.
|
DBR_CTRL_DOUBLE
Type representing a double-precision floating-point value with alarm
information, engineering units, display precision, and alarm, controls,
and display limits.
|
DBR_CTRL_ENUM
Type representing an enum value with alarm information and labels.
|
DBR_CTRL_FLOAT
Type representing a single-precision floating-point value with alarm
information, engineering units, display precision, and alarm, control,
and display limits.
|
DBR_CTRL_LONG
Type representing an integer value with alarm information, engineering
units, and alarm, control, and display limits.
|
DBR_CTRL_SHORT
Type representing a short integer value with alarm information,
engineering units, and alarm, control, and display limits.
|
DBR_CTRL_STRING
Type representing a string value with alarm information.
|
DBR_DOUBLE
Type representing a simple double-precision floating-point value.
|
DBR_ENUM
Type representing a simple enum value.
|
DBR_FLOAT
Type representing a simple single-precision floating-point value.
|
DBR_GR_CHAR
Type representing a simple byte value with alarm information, engineering
units, and alarm and display limits.
|
DBR_GR_DOUBLE
Type representing a double-precision floating-point value with alarm
information, engineering units, display precision, and alarm and display
limits.
|
DBR_GR_ENUM
Type representing an enum value with alarm information and labels.
|
DBR_GR_FLOAT
Type representing a single-precision floating-point value with alarm
information, engineering units, display precision, and alarm and display
limits.
|
DBR_GR_LONG
Type representing an integer value with alarm information, engineering
units, and alarm and display limits.
|
DBR_GR_SHORT
Type representing a short integer value with alarm information,
engineering units, and alarm and display limits.
|
DBR_GR_STRING
Type representing a string value with alarm information.
|
DBR_LONG
Type representing a simple integer value.
|
DBR_PUT_ACKS
Type used to acknowledge alarms.
|
DBR_PUT_ACKT
Type used to configure the transient alarm setting.
|
DBR_SHORT
Type representing a simple short integer value.
|
DBR_STRING
Type representing a simple string value.
|
DBR_STS_CHAR
Type representing a simple byte value with alarm information.
|
DBR_STS_DOUBLE
Type representing a double-precision floating-point value with alarm
information.
|
DBR_STS_ENUM
Type representing an enum value with alarm information.
|
DBR_STS_FLOAT
Type representing a single-precision floating-point value with alarm
information.
|
DBR_STS_LONG
Type representing an integer value with alarm information.
|
DBR_STS_SHORT
Type representing a short integer value with alarm information.
|
DBR_STS_STRING
Type representing a string value with alarm information.
|
DBR_STSACK_STRING
Type used to retrieve information about acknowledged and unacknowledged
alarms.
|
DBR_TIME_CHAR
Type representing a simple byte value with alarm information and a
time-stamp.
|
DBR_TIME_DOUBLE
Type representing a double-precision floating-point value with alarm
information and a time-stamp.
|
DBR_TIME_ENUM
Type representing an enum value with alarm information and a time-stamp.
|
DBR_TIME_FLOAT
Type representing a single-precision floating-point value with alarm
information and a time-stamp.
|
DBR_TIME_LONG
Type representing an integer value with alarm information and a
time-stamp.
|
DBR_TIME_SHORT
Type representing a short integer value with alarm information and a
time-stamp.
|
DBR_TIME_STRING
Type representing a string value with alarm information and a time-stamp.
|
Modifier and Type | Method and Description |
---|---|
static ChannelAccessValueType |
forTypeNumber(short typeNumber)
Returns the Channel Access data-type that is identified by the specified
type number.
|
boolean |
includesAlarm()
Returns
true if this type includes alarm information. |
boolean |
includesGraphics()
Returns
true if this type includes display information. |
boolean |
isAlarmType()
Returns whether this type represents a type with alarm information (but
no additional information).
|
boolean |
isControlsType()
Returns
true if this type represents a type with alarm,
display, and control limits information. |
boolean |
isGettable()
Returns
true if this type can be used in a get operation
(transferring data from a server to a client), false
otherwise. |
boolean |
isGraphicsType()
Returns
true if this type represents a type with alarm and
display information. |
boolean |
isPuttable()
Returns
true if this type can be used in a put
operation(transferring data from a client to a server),
false otherwise. |
boolean |
isSimpleType()
Returns whether this type represents a simple type.
|
boolean |
isSpecialType()
Returns
true if this type is one of the special types,
false otherwise. |
boolean |
isTimeType()
Returns whether this type represents a type with a time-stamp.
|
ChannelAccessValueType |
toAlarmType()
Returns the alarm type that corresponds to this type (has the same value
type).
|
ChannelAccessValueType |
toControlsType()
Returns the controls type that corresponds to this type (has the same
value type).
|
ChannelAccessValueType |
toGraphicsType()
Returns the graphics type that corresponds to this type (has the same
value type).
|
ChannelAccessValueType |
toSimpleType()
Returns the simple type that corresponds to this type (has the same value
type).
|
ChannelAccessValueType |
toTimeType()
Returns the time type that corresponds to this type (has the same value
type).
|
short |
toTypeCode()
Returns the type number.
|
static ChannelAccessValueType |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ChannelAccessValueType[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ChannelAccessValueType DBR_STRING
ChannelAccessSimpleOnlyString
public static final ChannelAccessValueType DBR_SHORT
ChannelAccessSimpleOnlyShort
public static final ChannelAccessValueType DBR_FLOAT
ChannelAccessSimpleOnlyFloat
public static final ChannelAccessValueType DBR_ENUM
ChannelAccessSimpleOnlyEnum
public static final ChannelAccessValueType DBR_CHAR
DBR_CHAR
, however it represents an 8-bit integer (
byte
in Java). Channel Access specifies that this type is
unsigned, but due to limitations of the Java platform, we us the signed
version.ChannelAccessSimpleOnlyChar
public static final ChannelAccessValueType DBR_LONG
DBR_LONG
, however it represents a 32-bit
integer (int
in Java).ChannelAccessSimpleOnlyLong
public static final ChannelAccessValueType DBR_DOUBLE
ChannelAccessSimpleOnlyDouble
public static final ChannelAccessValueType DBR_STS_STRING
ChannelAccessAlarmOnlyString
public static final ChannelAccessValueType DBR_STS_SHORT
ChannelAccessAlarmOnlyShort
public static final ChannelAccessValueType DBR_STS_FLOAT
ChannelAccessAlarmOnlyFloat
public static final ChannelAccessValueType DBR_STS_ENUM
ChannelAccessAlarmOnlyEnum
public static final ChannelAccessValueType DBR_STS_CHAR
DBR_STS_CHAR
,
however it represents an 8-bit integer (byte
in Java).
Channel Access specifies that this type is unsigned, but due to
limitations of the Java platform, we us the signed version.ChannelAccessAlarmOnlyChar
public static final ChannelAccessValueType DBR_STS_LONG
DBR_STS_LONG
, however it
represents a 32-bit integer (int
in Java).ChannelAccessAlarmOnlyLong
public static final ChannelAccessValueType DBR_STS_DOUBLE
ChannelAccessAlarmOnlyDouble
public static final ChannelAccessValueType DBR_TIME_STRING
ChannelAccessTimeString
public static final ChannelAccessValueType DBR_TIME_SHORT
ChannelAccessTimeShort
public static final ChannelAccessValueType DBR_TIME_FLOAT
ChannelAccessTimeFloat
public static final ChannelAccessValueType DBR_TIME_ENUM
ChannelAccessTimeEnum
public static final ChannelAccessValueType DBR_TIME_CHAR
DBR_TIME_CHAR
, however it represents an 8-bit integer (
byte
in Java). Channel Access specifies that this type is
unsigned, but due to limitations of the Java platform, we us the signed
version.ChannelAccessTimeChar
public static final ChannelAccessValueType DBR_TIME_LONG
DBR_TIME_LONG
, however it represents a 32-bit integer (
int
in Java).ChannelAccessTimeLong
public static final ChannelAccessValueType DBR_TIME_DOUBLE
ChannelAccessTimeDouble
public static final ChannelAccessValueType DBR_GR_STRING
DBR_STS_STRING
.ChannelAccessAlarmOnlyString
public static final ChannelAccessValueType DBR_GR_SHORT
ChannelAccessGraphicsOnlyShort
public static final ChannelAccessValueType DBR_GR_FLOAT
ChannelAccessGraphicsOnlyFloat
public static final ChannelAccessValueType DBR_GR_ENUM
ChannelAccessGraphicsEnum
public static final ChannelAccessValueType DBR_GR_CHAR
DBR_GR_CHAR
, however it represents an 8-bit integer (
byte
in Java). Channel Access specifies that this type is
unsigned, but due to limitations of the Java platform, we us the signed
version.ChannelAccessGraphicsOnlyChar
public static final ChannelAccessValueType DBR_GR_LONG
DBR_GR_LONG
, however it represents a 32-bit integer (
int
in Java).ChannelAccessGraphicsOnlyLong
public static final ChannelAccessValueType DBR_GR_DOUBLE
ChannelAccessGraphicsOnlyDouble
public static final ChannelAccessValueType DBR_CTRL_STRING
DBR_STS_STRING
.ChannelAccessAlarmOnlyString
public static final ChannelAccessValueType DBR_CTRL_SHORT
ChannelAccessControlsShort
public static final ChannelAccessValueType DBR_CTRL_FLOAT
ChannelAccessControlsFloat
public static final ChannelAccessValueType DBR_CTRL_ENUM
DBR_GR_ENUM
. Internally, an enum is simply a short, but it is
interpreted as a set of states to choose from.ChannelAccessGraphicsEnum
public static final ChannelAccessValueType DBR_CTRL_CHAR
DBR_CTRL_CHAR
, however it represents an
8-bit integer ( byte
in Java). Channel Access specifies that
this type is unsigned, but due to limitations of the Java platform, we us
the signed version.ChannelAccessControlsChar
public static final ChannelAccessValueType DBR_CTRL_LONG
DBR_CTRL_LONG
, however it represents a
32-bit integer ( int
in Java).ChannelAccessControlsLong
public static final ChannelAccessValueType DBR_CTRL_DOUBLE
ChannelAccessControlsDouble
public static final ChannelAccessValueType DBR_PUT_ACKT
public static final ChannelAccessValueType DBR_PUT_ACKS
ChannelAccessAcknowledgeAlarm
public static final ChannelAccessValueType DBR_STSACK_STRING
public static final ChannelAccessValueType DBR_CLASS_NAME
ChannelAccessClassName
public static ChannelAccessValueType[] values()
for (ChannelAccessValueType c : ChannelAccessValueType.values()) System.out.println(c);
public static ChannelAccessValueType valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic short toTypeCode()
forTypeNumber(short)
public boolean isSimpleType()
DBR_PUT_ACKT
,
DBR_PUT_ACKS
, DBR_STSACK_STRING
, and
DBR_CLASS_NAME
types are not considers simple types because they
do not transport plain values but have special meanings. Therefore, this
method returns false
for these types.true
if this type represents a simple type,
false
otherwise.public boolean isAlarmType()
true
for the
DBR_STS_*
types. This method returns false
for
the DBR_STSACK_STRING
type, because it is considered a special,
even though it transports alarm information.true
if this type represent a (pure) type with alarm
information, false
otherwise.includesAlarm()
public boolean isTimeType()
true
for the DBR_TIME_*
types.true
if this type represents a type with alarm
information, false
otherwise.public boolean isGraphicsType()
true
if this type represents a type with alarm and
display information. This is true
for the
DBR_GR_*
types, including DBR_GR_STRING
, even
though it does not provide control limits.true
if this type represents a type with alarm and
display information, false
otherwise.includesGraphics()
public boolean isControlsType()
true
if this type represents a type with alarm,
display, and control limits information. This is true
for
the DBR_CTRL*
types, including DBR_CTRL_STRING
,
even though it does not provide control limits.true
if this type represents a type with alarm,
display, and control limits information, false
otherwise.public boolean isSpecialType()
true
if this type is one of the special types,
false
otherwise. DBR_PUT_ACKT
,
DBR_PUT_ACKS
, DBR_STSACK_STRING
, and
DBR_CLASS_NAME
are considered special types because they cannot
be converted between simple, alarm, time, graphics, and controls types.true
if this type is a @link #DBR_PUT_ACKT},
DBR_PUT_ACKS
, DBR_STSACK_STRING
, or
DBR_CLASS_NAME
, false
otherwise.public boolean isGettable()
true
if this type can be used in a get operation
(transferring data from a server to a client), false
otherwise. The regular types (isSpecialType()
== false
), DBR_STSACK_STRING
, and
DBR_CLASS_NAME
are gettable. Only DBR_PUT_ACKT
and
DBR_PUT_ACKS
are not gettable.true
if this type is gettable, false
otherwise.public boolean isPuttable()
true
if this type can be used in a put
operation(transferring data from a client to a server),
false
otherwise. The simple types (isSimpleType()
== true
), DBR_PUT_ACKT
, and DBR_PUT_ACKS
are puttable.true
if this type is puttable, false
otherwise.public boolean includesAlarm()
true
if this type includes alarm information. This
is true
for the DBR_STS_*
,
DBR_TIME_*
, DBR_GR_*
, and
DBR_CTRL_*
types. This method returns false
for
the DBR_STSACK_STRING
type, because it is considered a simple
type, even though it transports alarm information.true
if this type provides alarm information,
false
otherwise.isAlarmType()
public boolean includesGraphics()
true
if this type includes display information. This
is true
for the DBR_GR_*
and
DBR_CTRL_*
types, including the DBR_GR_STRING
and
DBR_CTRL_STRING
types, even though they do not provide display
information.true
if this type provides display information,
false
otherwise.isGraphicsType()
public ChannelAccessValueType toSimpleType()
isSimpleType()
public ChannelAccessValueType toAlarmType()
DBR_PUT_ACKT
, DBR_PUT_ACKS
,
DBR_STSACK_STRING
, or DBR_CLASS_NAME
type results in an
IllegalArgumentException
being thrown, because there are no
corresponding alarm types for these types.IllegalArgumentException
- if there is no alarm type corresponding to this type.isAlarmType()
public ChannelAccessValueType toTimeType()
DBR_PUT_ACKT
, DBR_PUT_ACKS
,
DBR_STSACK_STRING
, or DBR_CLASS_NAME
type results in an
IllegalArgumentException
being thrown, because there are no
corresponding time types for these types.IllegalArgumentException
- if there is no time type corresponding to this type.isTimeType()
public ChannelAccessValueType toGraphicsType()
DBR_PUT_ACKT
,
DBR_PUT_ACKS
, DBR_STSACK_STRING
, or
DBR_CLASS_NAME
type results in an
IllegalArgumentException
being thrown, because there are no
corresponding graphics types for these types.IllegalArgumentException
- if there is no graphics type corresponding to this type.isTimeType()
public ChannelAccessValueType toControlsType()
DBR_PUT_ACKT
,
DBR_PUT_ACKS
, DBR_STSACK_STRING
, or
DBR_CLASS_NAME
type results in an
IllegalArgumentException
being thrown, because there are no
corresponding controls types for these types.IllegalArgumentException
- if there is no controls type corresponding to this type.isTimeType()
public static ChannelAccessValueType forTypeNumber(short typeNumber)
typeNumber
- type number identifying the requested type.null
).IllegalArgumentException
- if the specified number does not identify a valid Channel
Access data-type.toTypeCode()
Copyright © 2014–2016 aquenos GmbH. All rights reserved.