org.lsst.ccs.drivers.opc

Enum ScalarType

java.lang.Object

java.lang.Enum<ScalarType>

org.lsst.ccs.drivers.opc.ScalarType

All Implemented Interfaces:

Serializable, Comparable<ScalarType>

public enum ScalarType
extends Enum<ScalarType>

Gives the non-array data types returnable by an OPC service. See Appendix C in the manual that comes with the Matrikon OPC Server for Simulation. In the standard Windows installation that's in C:\Program Files (x86)\Matrikon\OPC\Simulation\.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
ILLEGAL_TYPE Not a recognized type code.
VT_BOOL Boolean.
VT_BSTR Unicode string, encoded on the server as UTF-16LE.
VT_CY Currency.
VT_DATE A A double counting the number of days, including a fraction, since 0 hours on Dec 30 1899.
VT_EMPTY Nada.
VT_ERROR 32-bit error code.
VT_I1 Signed byte.
VT_I2 2-byte signed integer.
VT_I4 4-byte signed integer.
VT_R4 IEEE single.
VT_R8 IEEE double.
VT_UI1 Unsigned byte.
VT_UI2 Unsigned short.
VT_UI4 Unsigned int.

Method Summary

Modifier and Type	Method and Description
static ScalarType	fromCode(int code) Converts a an OPC type code to an ScalarType.
int	getCode() Gets the numerical code designating the OPC type.
static ScalarType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScalarType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VT_EMPTY

public static final ScalarType VT_EMPTY

Nada.

VT_I2

public static final ScalarType VT_I2

2-byte signed integer.

VT_I4

public static final ScalarType VT_I4

4-byte signed integer.

VT_R4

public static final ScalarType VT_R4

IEEE single.

VT_R8

public static final ScalarType VT_R8

IEEE double.

VT_CY

public static final ScalarType VT_CY

Currency. Eight-byte singed integer scaled to allow 4 decimal places, for example $12.34 is represented as 123400.

VT_DATE

public static final ScalarType VT_DATE

A A double counting the number of days, including a fraction, since 0 hours on Dec 30 1899.

VT_BSTR

public static final ScalarType VT_BSTR

Unicode string, encoded on the server as UTF-16LE.

VT_ERROR

public static final ScalarType VT_ERROR

32-bit error code.

VT_BOOL

public static final ScalarType VT_BOOL

Boolean. 0 = false, -1 = true

VT_I1

public static final ScalarType VT_I1

Signed byte. Treated as a Java char value by the j-interop library.

VT_UI1

public static final ScalarType VT_UI1

Unsigned byte.

VT_UI2

public static final ScalarType VT_UI2

Unsigned short.

VT_UI4

public static final ScalarType VT_UI4

Unsigned int.

ILLEGAL_TYPE

public static final ScalarType ILLEGAL_TYPE

Not a recognized type code.

Method Detail

values

public static ScalarType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScalarType c : ScalarType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScalarType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Gets the numerical code designating the OPC type.

Returns:

The code.

fromCode

public static ScalarType fromCode(int code)

Converts a an OPC type code to an ScalarType.

Parameters:

code - The OPC type code (five bits).

Returns:

The type enumerator.