fr.esrf.TangoDs

Class TemplCommandOut

java.lang.Object

fr.esrf.TangoDs.Command

fr.esrf.TangoDs.TemplCommand

fr.esrf.TangoDs.TemplCommandOut

All Implemented Interfaces:

TangoConst

public class TemplCommandOut
extends TemplCommand
implements TangoConst

This class is a class representing a command in the template command model without input parameter but with output parameter

Version:

$Revision: 25297 $

Author:

$Author: pascal_verdier $

Field Summary

Fields inherited from class fr.esrf.TangoDs.TemplCommand

exe_method, exe_method_name, state_method, state_method_name

Fields inherited from class fr.esrf.TangoDs.Command

device_class_name, disp_level, in_type, in_type_desc, name, out_type, out_type_desc, poll_period, template_cmd

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, INTERFACE_CHANGE, 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, PIPE_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_ENUM, Tango_DEV_FLOAT, Tango_DEV_INT, Tango_DEV_LONG, Tango_DEV_LONG64, Tango_DEV_PIPE_BLOB, 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_BOOLEANARRAY, 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

Constructors

Constructor and Description
TemplCommandOut(String name, String exe_method) Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method.
TemplCommandOut(String name, String exe_method, fr.esrf.Tango.DispLevel disp) Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method.
TemplCommandOut(String name, String exe_method, String state_method) Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method.
TemplCommandOut(String name, String exe_method, String state_method, fr.esrf.Tango.DispLevel disp) Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method.
TemplCommandOut(String name, String exe_method, String in_desc, String out_desc) Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a description for the input and output command parameters The command display type is set to OPERATOR_CMD.
TemplCommandOut(String name, String exe_method, String in_desc, String out_desc, fr.esrf.Tango.DispLevel disp) Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a description for the input and output command parameters
TemplCommandOut(String name, String exe_method, String state_method, String in_desc, String out_desc) Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters.
TemplCommandOut(String name, String exe_method, String state_method, String in_desc, String out_desc, fr.esrf.Tango.DispLevel disp) Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters.

Method Summary

Modifier and Type	Method and Description
void	analyse_methods() Analyse the method given at construction time.
Any	execute(DeviceImpl dev, Any in_any) Invoke the command execution method given at object creation time.
boolean	is_allowed(DeviceImpl dev, Any data_in) Invoke the command allowed method given at object creation time.

Methods inherited from class fr.esrf.TangoDs.TemplCommand

analyse_method_state, find_method, get_tango_type

Methods inherited from class fr.esrf.TangoDs.Command

extract_DevBoolean, extract_DevDouble, extract_DevFloat, extract_DevLong, extract_DevLong64, extract_DevShort, extract_DevState, extract_DevString, extract_DevULong, extract_DevULong64, extract_DevUShort, extract_DevVarCharArray, extract_DevVarDoubleArray, extract_DevVarDoubleStringArray, extract_DevVarFloatArray, extract_DevVarLong64Array, extract_DevVarLongArray, extract_DevVarLongStringArray, extract_DevVarShortArray, extract_DevVarStringArray, extract_DevVarULong64Array, extract_DevVarULongArray, extract_DevVarUShortArray, get_device_class_name, get_disp_level, get_in_type_desc, get_in_type, get_name, get_out_type_desc, get_out_type, get_polling_period, get_tag, insert_u, insert_u, insert_u, insert_u, insert_u, insert_u, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, is_template, set_device_class_name, set_disp_level, set_in_type_desc, set_out_type_desc, set_polling_period

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       String state_method)

Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method. This constructor set the command input and output type to Tango_DEV_VOID The input and output parameter description are set to the default String "Uninitialised". The command display type is set to OPERATOR_CMD.

Parameters:

name - The command name

exe_method - The command execution method name

state_method - The command allowed method name

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method)

Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method. This constructor set the command input and output type to Tango_DEV_VOID. The input and output parameter description are set to the default String "Uninitialised". The command display type is set to OPERATOR_CMD.

Parameters:

name - The command name

exe_method - The command execution method name

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       String state_method,
                       String in_desc,
                       String out_desc)

Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters. This constructor set the command input and output type to Tango_DEV_VOID The command display type is set to OPERATOR_CMD.

Parameters:

name - The command name

exe_method - The command execution method name

state_method - The command allowed method name

in_desc - The command input parameter description

out_desc - The command output parameter description

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       String in_desc,
                       String out_desc)

Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a description for the input and output command parameters The command display type is set to OPERATOR_CMD.

Parameters:

name - The command name

exe_method - The command execution method name

in_desc - The command input parameter description

out_desc - The command output parameter description

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       String state_method,
                       fr.esrf.Tango.DispLevel disp)

Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method. This constructor set the command input and output type to Tango_DEV_VOID The input and output parameter description are set to the default String "Uninitialised".

Parameters:

name - The command name

exe_method - The command execution method name

state_method - The command allowed method name

disp - The command display type

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       fr.esrf.Tango.DispLevel disp)

Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method. This constructor set the command input and output type to Tango_DEV_VOID. The input and output parameter description are set to the default String "Uninitialised".

Parameters:

name - The command name

exe_method - The command execution method name

disp - The command display type

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       String state_method,
                       String in_desc,
                       String out_desc,
                       fr.esrf.Tango.DispLevel disp)

Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters. This constructor set the command input and output type to Tango_DEV_VOID

Parameters:

name - The command name

exe_method - The command execution method name

state_method - The command allowed method name

in_desc - The command input parameter description

out_desc - The command output parameter description

disp - The command display type

TemplCommandOut

public TemplCommandOut(String name,
                       String exe_method,
                       String in_desc,
                       String out_desc,
                       fr.esrf.Tango.DispLevel disp)

Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a description for the input and output command parameters

Parameters:

name - The command name

exe_method - The command execution method name

in_desc - The command input parameter description

out_desc - The command output parameter description

disp - The command display type

Method Detail

analyse_methods

public void analyse_methods()
                     throws fr.esrf.Tango.DevFailed

Analyse the method given at construction time. This method check if the method(s) given at construction time fulfill the required specification. It always analyse the execution method and eventually the command allowed method. The analysis of the command execution method will also set the command output type to the correct value depending on the execution method output parameter type

Overrides:

analyse_methods in class TemplCommand

Throws:

fr.esrf.Tango.DevFailed - If one of the method does not fulfill the requirements Click here to read DevFailed exception specification

is_allowed

public boolean is_allowed(DeviceImpl dev,
                          Any data_in)

Invoke the command allowed method given at object creation time. This method is automtically called by the TANGO core classes when the associated command is requested by a client to check if the command is allowed in the actual device state. If the user give a command allowed method at object creation time, this method will be invoked.

Overrides:

is_allowed in class TemplCommand

Parameters:

dev - The device on which the command must be executed

data_in - The incoming data still packed in a CORBA Any object. For command created with this TemplCommandOut class, this Any object does not contain data

Returns:

A boolean set to true is the command is allowed. Otherwise, the return value is false. This return value is always set to true if the user does not supply a method to be excuted. If a method has been supplied, the return value is the value returned by the user supplied mehod.

execute

public Any execute(DeviceImpl dev,
                   Any in_any)
            throws fr.esrf.Tango.DevFailed

Invoke the command execution method given at object creation time. This method is automtically called by the TANGO core classes when the associated command is requested by a client. It invokes the user supplied command execution method and packs the returned data into the outgoing CORBA Any object

Overrides:

execute in class TemplCommand

Parameters:

dev - The device on which the command must be executed

in_any - The incoming data still packed in a CORBA Any object. For command created with this TemplCommandOut class, this Any object does not contain usefull data

Returns:

The CORBA Any object returned to the client.

Throws:

fr.esrf.Tango.DevFailed - If the execution method failed Click here to read DevFailed exception specification