cern.cmw
Class SLEquipData

java.lang.Object
  extended by cern.cmw.Data
      extended by cern.cmw.SLEquipData
All Implemented Interfaces:
Serializable

public final class SLEquipData
extends Data

See Also:
Serialized Form

Constructor Summary
SLEquipData()
           
 
Method Summary
 void setCycle(String ucycle)
          Method to set the SL-Equip cycle as a String.
 void setUserDataType(String udatatype)
          Method to set the SL-Equip user data type as a String Data type desriptions follow the standard used by AQUIP.
 void setUserOption(byte[] uoption)
          Method to set the SL-Equip user option as a array of bytes
 void setUserOption(String uoption)
          Method to set the SL-Equip user option as a String
 
Methods inherited from class cern.cmw.Data
add, contains, copy, extractBoolean, extractBoolean, extractBooleanArray, extractBooleanArray, extractByte, extractByte, extractByteArray, extractByteArray, extractDouble, extractDouble, extractDoubleArray, extractDoubleArray, extractFloat, extractFloat, extractFloatArray, extractFloatArray, extractInt, extractInt, extractIntArray, extractIntArray, extractLong, extractLong, extractLongArray, extractLongArray, extractObject, extractObject, extractShort, extractShort, extractShortArray, extractShortArray, extractString, extractString, extractStringArray, extractStringArray, get, getTags, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insertObject, insertObject, isEmpty, remove, removeAll, size, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SLEquipData

public SLEquipData()
Method Detail

setUserOption

public final void setUserOption(String uoption)
Method to set the SL-Equip user option as a String

Parameters:
uoption - String specifying the user SL-Equip "user option".

setUserOption

public final void setUserOption(byte[] uoption)
Method to set the SL-Equip user option as a array of bytes

Parameters:
uoption - array of bytes specifying the user SL-Equip "user option".

setCycle

public final void setCycle(String ucycle)
Method to set the SL-Equip cycle as a String. It is only useful with a monitorOn() call. In this case the specified cycle will be used at the time of the poll to obtain data for subscription update.

If the cycle is not set with this call, then the cycle selector of the monitorOn() call will be used in the poll.

Parameters:
ucycle - String specifying the SL-Equip "cycle" for the poll, for instance "211b0101".

setUserDataType

public final void setUserDataType(String udatatype)
Method to set the SL-Equip user data type as a String

Data type desriptions follow the standard used by AQUIP. In this desciption the type is designated by a single letter as explained in the following. Letter without prefix or with prefix 0 is mapped to a CMW scalar type. Letter with a prefix is mapped to a CMW array type. In the latter case the value of the prefix corresponds to the maximum size of the array.

Description of composite properties (properties which consist of more than one scalar or array) are not allowed in this method (but can be can be defined in the database).

The mappings are defined as follows:

Type descriptions Equip modes Java type
"d" or "nd" RBR, WBR double or double[]
"D" or "nD" RAR, WAR double or double[]
"s" or "ns" RBI, WBI short or short[]
"S" or "nS" RAI, WAI short or short[]
"c" or "nc" RS, WS String
"b" or "nb" RB, WB byte or byte[]

Examples:

"5d" designates an array of 5 doubles and "1d" describes an array of 1 double. Both are mapped to the cmw type DataEntry.TYPE_DOUBLE_ARRAY. "d" and "0d" both designate one double and are mapped to DataEntry.TYPE_DOUBLE.

Parameters:
udatatype - String specifying the SL-Equip data type in form "nX" where n is the optional size and X a single letter type specification.


Copyright © 2007 CERN. All Rights Reserved.