TANGO Java API
( TangORB-7.3.3.jar)

fr.esrf.TangoDs
Class WAttribute

java.lang.Object
  extended by fr.esrf.TangoDs.Attribute
      extended by fr.esrf.TangoDs.WAttribute
All Implemented Interfaces:
TangoConst

public class WAttribute
extends Attribute
implements TangoConst

This class represents a writable attribute. It inherits from the Attribute class and only add what is specific to writable attribute.

Version:
$Revision: 1.6 $
Author:
$Author: pascal_verdier $ // // Copyright (C) : 2004,2005,2006,2007,2008,2009 // European Synchrotron Radiation Facility // BP 220, Grenoble 38043 // FRANCE // // This file is part of Tango. // // Tango is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Tango is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Tango. If not, see . // // $Revision: 1.6 $ // // $Log: WAttribute.java,v $ // Revision 1.6 2009/03/25 13:33:28 pascal_verdier // ... // // Revision 1.5 2009/01/16 12:37:13 pascal_verdier // IntelliJIdea warnings removed. // // Revision 1.4 2008/10/10 11:30:46 pascal_verdier // Headers changed for LGPL conformity. // // Revision 1.3 2008/07/30 09:00:31 pascal_verdier // min/max comparaison is now strict. // // Revision 1.2 2008/03/13 08:57:57 pascal_verdier // clone() method added. // value and min_value are now compeared strictly. // // Revision 1.1 2007/08/23 08:33:25 ounsy // updated change from api/java // // Revision 3.8 2007/05/29 08:07:43 pascal_verdier // Long64, ULong64, ULong, UShort and DevState attributes added. // // Revision 3.7 2006/09/18 11:10:49 pascal_verdier // Write boolean attribute bug fixed. // // Revision 3.6 2005/12/02 09:55:46 pascal_verdier // java import have been optimized. // // Revision 3.5 2004/03/12 14:07:57 pascal_verdier // Use JacORB-2.1 // // Revision 2.0 2003/01/09 16:02:58 taurel // - Update release number before using SourceForge // // Revision 1.1.1.1 2003/01/09 15:54:40 taurel // Imported sources into CVS before using SourceForge // // Revision 1.6 2001/10/10 08:11:26 taurel // See Tango WEB pages for list of changes // // Revision 1.5 2001/07/04 15:06:39 taurel // Many changes due to new release // // Revision 1.2 2001/05/04 12:03:22 taurel // Fix bug in the Util.get_device_by_name() method // // Revision 1.1.1.1 2001/04/04 08:23:54 taurel // Imported sources // // Revision 1.3 2000/04/13 08:23:02 taurel // Added attribute support // // // copyleft : European Synchrotron Radiation Facility // BP 220, Grenoble 38043 // FRANCE // //-============================================================================ package fr.esrf.TangoDs; import fr.esrf.Tango.*; import org.omg.CORBA.Any; import org.omg.CORBA.BAD_OPERATION; import java.util.Vector; /** This class represents a writable attribute. It inherits from the Attribute class and only add what is specific to writable attribute., $Author: pascal_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
WAttribute(java.util.Vector prop_list, Attr tmp_attr, java.lang.String dev_name)
          Create a new WAttribute object.
 
Method Summary
 java.lang.Object clone()
          Clone this object This is a deep copy because all attributes are primary except DevState.
 boolean get_bool_write_value()
          Deprecated.  
 double get_db_write_value()
          Deprecated.  
 int get_lg_write_value()
          Deprecated.  
 long get_lg64_write_value()
          Deprecated.  
 short get_sh_write_value()
          Deprecated.  
 DevState get_state_write_value()
          Deprecated.  
 java.lang.String get_str_write_value()
          Deprecated.  
 long get_ulg_write_value()
          Deprecated.  
 long get_ulg64_write_value()
          Deprecated.  
 int get_ush_write_value()
          Deprecated.  
 boolean getBooleanWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevBoolean
 double getDoubleWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevDouble.
 long getLong64WriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevLong64.
 int getLongWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevLong.
 short getShortWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevShort.
 DevState getStateWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevState
 java.lang.String getStringWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevString.
 long getULong64WriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevULong64.
 long getULongWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevULong.
 int getUShortWriteValue()
          Retrieve the new value for writable attribute when attribute data type is Tango_DevLong.
 
Methods inherited from class fr.esrf.TangoDs.Attribute
check_alarm, get_assoc_ind, get_assoc_name, get_data_format, get_data_size, get_data_type, get_date, get_name, get_properties, get_quality, get_when, get_writable, is_alarmed, is_max_alarm, is_min_alarm, is_writ_associated, set_assoc_ind, set_date, set_quality, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, set_value, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WAttribute

public WAttribute(java.util.Vector prop_list,
                  Attr tmp_attr,
                  java.lang.String dev_name)
           throws DevFailed
Create a new WAttribute object.

Parameters:
prop_list - The attribute properties list. Each property is an object of the AttrProperty class
tmp_attr - The temporary attribute object
dev_name - The device name
Throws:
DevFailed - If the creation of the Attribute object failed. Click here to read DevFailed exception specification
Method Detail

getStateWriteValue

public DevState getStateWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevState

Returns:
The new value sent by the caller

get_state_write_value

public DevState get_state_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevState

Returns:
The new value sent by the caller

getBooleanWriteValue

public boolean getBooleanWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevBoolean

Returns:
The new value sent by the caller

get_bool_write_value

public boolean get_bool_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevBoolean

Returns:
The new value sent by the caller

getShortWriteValue

public short getShortWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevShort.

Returns:
The new value sent by the caller

get_sh_write_value

public short get_sh_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevShort.

Returns:
The new value sent by the caller

getUShortWriteValue

public int getUShortWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevLong.

Returns:
The new value sent by the caller

get_ush_write_value

public int get_ush_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevUShort

Returns:
The new value sent by the caller

getLongWriteValue

public int getLongWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevLong.

Returns:
The new value sent by the caller

get_lg_write_value

public int get_lg_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevLong.

Returns:
The new value sent by the caller

getULongWriteValue

public long getULongWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevULong.

Returns:
The new value sent by the caller

get_ulg_write_value

public long get_ulg_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevULong.

Returns:
The new value sent by the caller

getLong64WriteValue

public long getLong64WriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevLong64.

Returns:
The new value sent by the caller

get_lg64_write_value

public long get_lg64_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevLong64.

Returns:
The new value sent by the caller

getULong64WriteValue

public long getULong64WriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevULong64.

Returns:
The new value sent by the caller

get_ulg64_write_value

public long get_ulg64_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevULong64.

Returns:
The new value sent by the caller

getDoubleWriteValue

public double getDoubleWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevDouble.

Returns:
The new value sent by the caller

get_db_write_value

public double get_db_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevDouble.

Returns:
The new value sent by the caller

getStringWriteValue

public java.lang.String getStringWriteValue()
Retrieve the new value for writable attribute when attribute data type is Tango_DevString.

Returns:
The new value sent by the caller

get_str_write_value

public java.lang.String get_str_write_value()
Deprecated. 

Retrieve the new value for writable attribute when attribute data type is Tango_DevString.

Returns:
The new value sent by the caller

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone this object This is a deep copy because all attributes are primary except DevState. But DevState reference an immutable object so we don't need to copy explicitly

Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException
See Also:
Object.clone()

TANGO Java API
( TangORB-7.3.3.jar)