fr.esrf.TangoApi
Class DeviceData

java.lang.Object
  fr.esrf.TangoApi.DeviceData

All Implemented Interfaces:

TangoConst

public class DeviceData
extends java.lang.Object
implements TangoConst

Class Description: This class manage data object for Tango device access.


Usage example:

String status;
DeviceProxy dev = ApiUtil.getDeviceProxy("sys/steppermotor/1");
try {

DeviceData data = dev.command_inout("DevStatus");
status = data.extractString();

}
catch (DevFailed e) {

status = "Unknown status";
Except.print_exception(e);

}

Version:

$Revision: 1.10 $

Author:

verdier

Field Summary

Fields inherited from interface fr.esrf.TangoDs.TangoConst

ACCESS_READ, ACCESS_SERVICE, ACCESS_WRITE, ARCHIVE_EVENT, ATT_CONF_EVENT, Attr_AdmName, Attr_Description, Attr_Name, Attr_State, Attr_Status, Attr_Unknown, ATTRIBUTE, BY_CLASS, BY_DEVICE, BY_PROCESS, CHANGE_EVENT, COMMAND, CONTROL_SYSTEM, DATA_READY_EVENT, DEFAULT_LOCK_VALIDITY, eventNames, LOGGING_CONSOLE_TARGET, LOGGING_CONSOLE_TARGET_ID, LOGGING_DEBUG, LOGGING_DEF_RFT, LOGGING_DEVICE_TARGET, LOGGING_DEVICE_TARGET_ID, LOGGING_ERROR, LOGGING_FATAL, LOGGING_FILE_TARGET, LOGGING_FILE_TARGET_ID, LOGGING_INFO, LOGGING_LEVELS, LOGGING_MAX_RFT, LOGGING_MIN_RFT, LOGGING_OFF, LOGGING_SEPARATOR, LOGGING_UNKNOWN_TARGET_ID, LOGGING_WARN, NO_SYNC, NOT_STATELESS, NotANumber, Op_BlackBox, Op_Command, Op_Command_2, Op_Command_inout, Op_Command_inout_2, Op_Command_inout_history_2, Op_Command_list, Op_Command_list_2, Op_Get_Attr_Config, Op_Get_Attr_Config_2, Op_Info, Op_Ping, Op_Read_Attr, Op_Read_Attr_2, Op_Read_Attr_history_2, Op_Set_Attr_Config, Op_Unknown, Op_Write_Attr, PERIODIC_EVENT, QUALITY_EVENT, Req_Attribute, Req_Operation, Req_Unknown, SERVICE_PROP_NAME, STATELESS, Tango_AllAttr, Tango_AllAttr_3, Tango_AlrmValueNotSpec, Tango_AssocWritNotSpec, Tango_AttrDataFormatName, Tango_CLNT_TIMEOUT, Tango_CmdArgTypeName, Tango_CONST_DEV_STRING, Tango_DbObjName, Tango_DEFAULT_POLL_OLD_FACTOR, Tango_DEFAULT_TIMEOUT, Tango_DEFAULT_TIMEOUT_SEC, Tango_DefaultBlackBoxDepth, Tango_DefaultDocUrl, Tango_DefaultPollRingDepth, Tango_DefaultWritableProp, Tango_DELTA_T, Tango_DescNotSet, Tango_DescNotSpec, Tango_DEV_BOOLEAN, Tango_DEV_CHAR, Tango_DEV_DOUBLE, Tango_DEV_ENCODED, Tango_DEV_FLOAT, Tango_DEV_INT, Tango_DEV_LONG, Tango_DEV_LONG64, Tango_DEV_SHORT, Tango_DEV_STATE, Tango_DEV_STRING, Tango_DEV_UCHAR, Tango_DEV_ULONG, Tango_DEV_ULONG64, Tango_DEV_USHORT, Tango_DEV_VOID, Tango_DevStateName, Tango_DEVVAR_CHARARRAY, Tango_DEVVAR_DOUBLEARRAY, Tango_DEVVAR_DOUBLESTRINGARRAY, Tango_DEVVAR_FLOATARRAY, Tango_DEVVAR_LONG64ARRAY, Tango_DEVVAR_LONGARRAY, Tango_DEVVAR_LONGSTRINGARRAY, Tango_DEVVAR_SHORTARRAY, Tango_DEVVAR_STRINGARRAY, Tango_DEVVAR_ULONG64ARRAY, Tango_DEVVAR_ULONGARRAY, Tango_DEVVAR_USHORTARRAY, Tango_DevVersion, Tango_DISCARD_THRESHOLD, Tango_DispUnitNotSpec, Tango_DSDeviceDomain, Tango_EXPERT_ATTR, Tango_EXPERT_CMD, Tango_FormatNotSpec, Tango_InitialOutput, Tango_LabelNotSpec, TANGO_LOG_PATH, Tango_MAX_TRANSFER_SIZE, Tango_MaxServerNameLength, Tango_MIN_POLL_PERIOD, Tango_OPERATOR_ATTR, Tango_OPERATOR_CMD, Tango_POLL_ADD_OBJ, Tango_POLL_ATTR, Tango_POLL_CMD, Tango_POLL_REM_DEV, Tango_POLL_REM_OBJ, Tango_POLL_START, Tango_POLL_STOP, Tango_POLL_UPD_PERIOD, Tango_PollAttribute, Tango_PollCommand, Tango_QualityName, Tango_REL_1, Tango_REL_2, Tango_ResNotDefined, Tango_StdUnitNotSpec, Tango_SysProperty, Tango_TG_IMP_MINOR_DEVFAILED, Tango_TG_IMP_MINOR_NON_DEVFAILED, Tango_TG_IMP_MINOR_TO, Tango_TgLibVers, Tango_UnitNotSpec, USER_EVENT

Constructor Summary

DeviceData()
Constructor for the TgApi Data Object.

DeviceData(org.omg.CORBA.Any any)
Constructor for the TgApi Data Object.

DeviceData(org.omg.CORBA.ORB orb)
Constructor for the TgApi Data Object.

Method Summary

org.omg.CORBA.Any	extractAny() extract method for a CORBA Any.
boolean	extractBoolean() extract method for a boolean.
byte[]	extractByteArray() extract method for a byte Array.
DevState	extractDevState() extract method for a DevState.
double	extractDouble() extract method for a double.
double[]	extractDoubleArray() extract method for a double Array.
DevVarDoubleStringArray	extractDoubleStringArray() extract method for a DevVarDoubleStringArray.
float	extractFloat() extract method for a float.
float[]	extractFloatArray() extract method for a float Array.
int	extractLong() extract method for a long.
long	extractLong64() extract method for a long.
long[]	extractLong64Array() extract method for a long64 Array.
int[]	extractLongArray() extract method for a long Array.
DevVarLongStringArray	extractLongStringArray() extract method for a DevVarLongStringArray.
short	extractShort() extract method for a short.
short[]	extractShortArray() extract method for a short Array.
java.lang.String	extractString() extract method for a String.
java.lang.String[]	extractStringArray() extract method for a String Array.
short	extractUChar() extract method for an unsigned char.
long	extractULong() extract method for an unsigned long.
long	extractULong64() extract method for an unsigned long.
long[]	extractULong64Array() extract method for a long64 Array.
long[]	extractULongArray() extract method for an unsigned long Array.
int	extractUShort() extract method for an unsigned short.
int[]	extractUShortArray() extract method for an unsigned short Array.
org.omg.CORBA.Any	getAny()
IDeviceDataDAO	getDevicedataDAO()
int	getType()
void	insert_u(int argin) Deprecated. use insert_ul(int/long argin)
void	insert_u(int[] argin) Deprecated. use insert_ul(int[]/long[] argin)
void	insert_u(short argin) Deprecated. use insert_us(short/int argin)
void	insert_u(short[] argin) Deprecated. use insert_us(short[]/int[] argin)
void	insert_u64(long argin) Insert method for argin is unsigned long 64.
void	insert_u64(long[] argin) Insert method for argin is unsigned long 64.array
void	insert_uc(byte argin) Insert method for argin is UCHAR.
void	insert_uc(short argin) Insert method for argin is UCHAR.
void	insert_ul(int argin) Insert method for argin is unsigned int.
void	insert_ul(int[] argin) Insert method for argin is unsigned int array.
void	insert_ul(long argin) Insert method for argin long ass unsigned int.
void	insert_ul(long[] argin) Insert method for argin long array as unsigned int array.
void	insert_us(int argin) Insert method for argin int as unsigned short.
void	insert_us(int[] argin) Insert method for argin int as unsigned short array.
void	insert_us(short argin) Insert method for argin is unsigned short.
void	insert_us(short[] argin) Insert method for argin is unsigned short array.
void	insert() Insert method for argin is void.
void	insert(org.omg.CORBA.Any any) Insert method for argin is Any (CORBA).
void	insert(boolean argin) Insert method for argin is boolean.
void	insert(byte[] argin) Insert method for argin is DevVarCharArray.
void	insert(DevState argin) Insert method for argin is DevState.
void	insert(DevVarDoubleStringArray argin) Insert method for argin is DevVarDoubleStringArray.
void	insert(DevVarLongStringArray argin) Insert method for argin is DevVarLongStringArray.
void	insert(double argin) Insert method for argin is double.
void	insert(double[] argin) Insert method for argin is DevVarDoubleArray.
void	insert(float argin) Insert method for argin is float.
void	insert(float[] argin) Insert method for argin is DevVarFloatArray.
void	insert(int argin) Insert method for argin is int.
void	insert(int[] argin) Insert method for argin is DevVarLongArray.
void	insert(long argin) Insert method for argin is long (64 bits)
void	insert(long[] argin) Insert method for argin is long array (64 bits)
void	insert(short argin) Insert method for argin is short.
void	insert(short[] argin) Insert method for argin is DevVarShortArray.
void	insert(java.lang.String argin) Insert method for argin is String.
void	insert(java.lang.String[] argin) Insert method for argin is DevVarStringArray.
void	setAny(org.omg.CORBA.Any any)
org.omg.CORBA.TypeCode	type()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceData

public DeviceData()
           throws DevFailed

Constructor for the TgApi Data Object.

Throws:

DevFailed - if TgApi class not instancied.

DeviceData

public DeviceData(org.omg.CORBA.ORB orb)
           throws DevFailed

Constructor for the TgApi Data Object.

Parameters:

orb - orb connection id.

Throws:

DevFailed - if TgApi class not instancied.

DeviceData

public DeviceData(org.omg.CORBA.Any any)
           throws DevFailed

Constructor for the TgApi Data Object.

Parameters:

any - CORBA Any reference to be used in DeviceData.

Throws:

DevFailed - if TgApi class not instancied.

Method Detail

insert

public void insert()

Insert method for argin is void.

insert

public void insert(org.omg.CORBA.Any any)

Insert method for argin is Any (CORBA).

insert

public void insert(boolean argin)

Insert method for argin is boolean.

Parameters:

argin - argin value for next command.

insert

public void insert(short argin)

Insert method for argin is short.

Parameters:

argin - argin value for next command.

insert

public void insert(long argin)

Insert method for argin is long (64 bits)

Parameters:

argin - argin value for next command.

insert

public void insert(int argin)

Insert method for argin is int.

Parameters:

argin - argin value for next command.

insert

public void insert(float argin)

Insert method for argin is float.

Parameters:

argin - argin value for next command.

insert

public void insert(double argin)

Insert method for argin is double.

Parameters:

argin - argin value for next command.

insert

public void insert(java.lang.String argin)

Insert method for argin is String.

Parameters:

argin - argin value for next command.

insert

public void insert(DevState argin)

Insert method for argin is DevState.

Parameters:

argin - argin value for next command.

insert

public void insert(byte[] argin)

Insert method for argin is DevVarCharArray.

Parameters:

argin - argin value for next command.

insert

public void insert(short[] argin)

Insert method for argin is DevVarShortArray.

Parameters:

argin - argin value for next command.

insert

public void insert(int[] argin)

Insert method for argin is DevVarLongArray.

Parameters:

argin - argin value for next command.

insert

public void insert(long[] argin)

Insert method for argin is long array (64 bits)

Parameters:

argin - argin value for next command.

insert

public void insert(float[] argin)

Insert method for argin is DevVarFloatArray.

Parameters:

argin - argin value for next command.

insert

public void insert(double[] argin)

Insert method for argin is DevVarDoubleArray.

Parameters:

argin - argin value for next command.

insert

public void insert(java.lang.String[] argin)

Insert method for argin is DevVarStringArray.

Parameters:

argin - argin value for next command.

insert

public void insert(DevVarLongStringArray argin)

Insert method for argin is DevVarLongStringArray.

Parameters:

argin - argin value for next command.

insert

public void insert(DevVarDoubleStringArray argin)

Insert method for argin is DevVarDoubleStringArray.

Parameters:

argin - argin value for next command.

insert_u64

public void insert_u64(long[] argin)

Insert method for argin is unsigned long 64.array

Parameters:

argin - argin value for next command.

insert_u64

public void insert_u64(long argin)

Insert method for argin is unsigned long 64.

Parameters:

argin - argin value for next command.

insert_uc

public void insert_uc(byte argin)

Insert method for argin is UCHAR.

Parameters:

argin - argin value for next command.

insert_uc

public void insert_uc(short argin)

Insert method for argin is UCHAR.

Parameters:

argin - argin value for next command.

insert_us

public void insert_us(int argin)

Insert method for argin int as unsigned short.

Parameters:

argin - argin value for next command.

insert_us

public void insert_us(short argin)

Insert method for argin is unsigned short.

Parameters:

argin - argin value for next command.

insert_u

public void insert_u(short argin)

Deprecated. use insert_us(short/int argin)

Insert method for argin is unsigned short.

Parameters:

argin - argin value for next command.

insert_ul

public void insert_ul(long argin)

Insert method for argin long ass unsigned int.

Parameters:

argin - argin value for next command.

insert_ul

public void insert_ul(int argin)

Insert method for argin is unsigned int.

Parameters:

argin - argin value for next command.

insert_u

public void insert_u(int argin)

Deprecated. use insert_ul(int/long argin)

Insert method for argin is unsigned int.

Parameters:

argin - argin value for next command.

insert_us

public void insert_us(int[] argin)

Insert method for argin int as unsigned short array.

Parameters:

argin - argin value for next command.

insert_us

public void insert_us(short[] argin)

Insert method for argin is unsigned short array.

Parameters:

argin - argin value for next command.

insert_u

public void insert_u(short[] argin)

Deprecated. use insert_us(short[]/int[] argin)

Insert method for argin is unsigned short array.

Parameters:

argin - argin value for next command.

insert_ul

public void insert_ul(long[] argin)

Insert method for argin long array as unsigned int array.

Parameters:

argin - argin value for next command.

insert_ul

public void insert_ul(int[] argin)

Insert method for argin is unsigned int array.

Parameters:

argin - argin value for next command.

insert_u

public void insert_u(int[] argin)

Deprecated. use insert_ul(int[]/long[] argin)

Insert method for argin is unsigned int array.

Parameters:

argin - argin value for next command.

extractAny

public org.omg.CORBA.Any extractAny()

extract method for a CORBA Any.

extractBoolean

public boolean extractBoolean()

extract method for a boolean.

extractUChar

public short extractUChar()

extract method for an unsigned char.

extractShort

public short extractShort()

extract method for a short.

extractUShort

public int extractUShort()

extract method for an unsigned short.

extractLong

public int extractLong()

extract method for a long.

extractLong64

public long extractLong64()

extract method for a long.

extractULong

public long extractULong()

extract method for an unsigned long.

extractULong64

public long extractULong64()

extract method for an unsigned long.

extractFloat

public float extractFloat()

extract method for a float.

extractDouble

public double extractDouble()

extract method for a double.

extractString

public java.lang.String extractString()

extract method for a String.

extractDevState

public DevState extractDevState()

extract method for a DevState.

extractByteArray

public byte[] extractByteArray()

extract method for a byte Array.

extractShortArray

public short[] extractShortArray()

extract method for a short Array.

extractUShortArray

public int[] extractUShortArray()

extract method for an unsigned short Array.

Returns:

extract value as int array

extractLongArray

public int[] extractLongArray()

extract method for a long Array.

extractLong64Array

public long[] extractLong64Array()

extract method for a long64 Array.

extractULongArray

public long[] extractULongArray()

extract method for an unsigned long Array.

Returns:

extract value as long array

extractULong64Array

public long[] extractULong64Array()

extract method for a long64 Array.

extractFloatArray

public float[] extractFloatArray()

extract method for a float Array.

extractDoubleArray

public double[] extractDoubleArray()

extract method for a double Array.

extractStringArray

public java.lang.String[] extractStringArray()

extract method for a String Array.

extractLongStringArray

public DevVarLongStringArray extractLongStringArray()

extract method for a DevVarLongStringArray.

extractDoubleStringArray

public DevVarDoubleStringArray extractDoubleStringArray()

extract method for a DevVarDoubleStringArray.

type

public org.omg.CORBA.TypeCode type()

getType

public int getType()
            throws DevFailed

Throws:

DevFailed

getAny

public org.omg.CORBA.Any getAny()

setAny

public void setAny(org.omg.CORBA.Any any)

getDevicedataDAO

public IDeviceDataDAO getDevicedataDAO()