TANGO Java API
( TangORB-7.3.3.jar)

fr.esrf.TangoDs
Class Attr

java.lang.Object
  extended by fr.esrf.TangoDs.Attr
All Implemented Interfaces:
TangoConst
Direct Known Subclasses:
SpectrumAttr

public class Attr
extends java.lang.Object
implements TangoConst

User class to create a no dimension attribute object. Information from this class and information fetched out from the Tango database allows the Tango core software to create the Attribute object for the attribute created by the user.

Version:
$Revision: 1.5 $
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.5 $ // // $Log: Attr.java,v $ // Revision 1.5 2009/03/25 13:33:28 pascal_verdier // ... // // Revision 1.4 2009/01/16 12:37:13 pascal_verdier // IntelliJIdea warnings removed. // // Revision 1.3 2008/10/10 11:30:46 pascal_verdier // Headers changed for LGPL conformity. // // Revision 1.2 2008/09/12 11:27:51 pascal_verdier // Tango 7 first revision. // // Revision 1.1 2007/08/23 08:33:25 ounsy // updated change from api/java // // Revision 3.10 2007/05/29 08:07:43 pascal_verdier // Long64, ULong64, ULong, UShort and DevState attributes added. // // Revision 3.9 2005/12/02 09:55:02 pascal_verdier // java import have been optimized. // // Revision 3.8 2005/06/13 09:08:42 pascal_verdier // Attribute historic buffer can be filled by trigger. // // Revision 3.7 2004/06/29 04:05:09 pascal_verdier // Comments used by javadoc added. // // Revision 3.6 2004/05/14 13:47:56 pascal_verdier // Compatibility with Tango-2.2.0 cpp // (polling commands and attibites). // // Revision 3.5 2004/03/12 14:07:56 pascal_verdier // Use JacORB-2.1 // // Revision 2.0 2003/01/09 16:02:57 taurel // - Update release number before using SourceForge // // Revision 1.1.1.1 2003/01/09 15:54:39 taurel // Imported sources into CVS before using SourceForge // // Revision 1.6 2001/10/10 08:11:22 taurel // See Tango WEB pages for list of changes // // Revision 1.5 2001/07/04 15:06:35 taurel // Many changes due to new release // // Revision 1.2 2001/05/04 12:03:20 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.1.1.1 2001/02/27 08:46:20 taurel // Imported sources // // // copyleft : European Synchrotron Radiation Facility // BP 220, Grenoble 38043 // FRANCE // //============================================================================= package fr.esrf.TangoDs; import fr.esrf.Tango.AttrDataFormat; import fr.esrf.Tango.AttrWriteType; import fr.esrf.Tango.DevFailed; import fr.esrf.Tango.DispLevel; import java.util.Vector; /** User class to create a no dimension attribute object. Information from this class and information fetched out from the Tango database allows the Tango core software to create the Attribute object for the attribute created by the user., $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
Attr(java.lang.String name, int data_type)
          Constructs a newly allocated Attr object.
Attr(java.lang.String name, int data_type, AttrWriteType w_type)
          Constructs a newly allocated Attr object.
Attr(java.lang.String name, int data_type, AttrWriteType w_type, DispLevel level)
          Constructs a newly allocated Attr object.
Attr(java.lang.String name, int data_type, AttrWriteType w_type, java.lang.String assoc)
          Constructs a newly allocated Attr object.
Attr(java.lang.String name, int data_type, AttrWriteType w_type, java.lang.String assoc, DispLevel level)
          Constructs a newly allocated Attr object.
Attr(java.lang.String name, int data_type, DispLevel level)
          Constructs a newly allocated Attr object.
 
Method Summary
 DispLevel get_disp_level()
           
 int get_polling_period()
           
 void set_default_properties(UserDefaultAttrProp prop_list)
          Set the attribute user default properties.
 void set_disp_level(DispLevel level)
           
 void set_polling_period(int p)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Attr

public Attr(java.lang.String name,
            int data_type,
            AttrWriteType w_type,
            java.lang.String assoc)
     throws DevFailed
Constructs a newly allocated Attr object. The attribute display type is set to OPERATOR_ATTR.

Parameters:
name - The attribute name
data_type - The attribute data type
w_type - The attribute type (read, write, read with write ...)
assoc - Name of the associated writable attribute. This is used only the read with write attribute
Throws:
DevFailed

Attr

public Attr(java.lang.String name,
            int data_type)
     throws DevFailed
Constructs a newly allocated Attr object. The attribute display type is set to OPERATOR_ATTR. The type of this attribute is set to READ.

Parameters:
name - The attribute name
data_type - The attribute data type
Throws:
DevFailed

Attr

public Attr(java.lang.String name,
            int data_type,
            AttrWriteType w_type)
     throws DevFailed
Constructs a newly allocated Attr object. The attribute display type is set to OPERATOR_ATTR.

Parameters:
name - The attribute name
data_type - The attribute data type
w_type - The attribute type (read, write, ...)
Throws:
DevFailed

Attr

public Attr(java.lang.String name,
            int data_type,
            AttrWriteType w_type,
            java.lang.String assoc,
            DispLevel level)
     throws DevFailed
Constructs a newly allocated Attr object.

Parameters:
name - The attribute name
data_type - The attribute data type
w_type - The attribute type (read, write, read with write ...)
assoc - Name of the associated writable attribute. This is used only the read with write attribute
level - The attribute display type
Throws:
DevFailed

Attr

public Attr(java.lang.String name,
            int data_type,
            DispLevel level)
     throws DevFailed
Constructs a newly allocated Attr object. The type of this attribute is set to READ.

Parameters:
name - The attribute name
data_type - The attribute data type
level - The attribute display type
Throws:
DevFailed

Attr

public Attr(java.lang.String name,
            int data_type,
            AttrWriteType w_type,
            DispLevel level)
     throws DevFailed
Constructs a newly allocated Attr object.

Parameters:
name - The attribute name
data_type - The attribute data type
w_type - The attribute type (read, write, ...)
level - The attribute display type
Throws:
DevFailed
Method Detail

set_default_properties

public void set_default_properties(UserDefaultAttrProp prop_list)
Set the attribute user default properties.

Parameters:
prop_list - The user default attribute properties

get_disp_level

public DispLevel get_disp_level()

set_disp_level

public void set_disp_level(DispLevel level)

get_polling_period

public int get_polling_period()

set_polling_period

public void set_polling_period(int p)

TANGO Java API
( TangORB-7.3.3.jar)