org.tango.server.annotation
Annotation Type Command


@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface Command

Declare a command of a tango device.

Declares a command myCommand with parameter of type int and returns double
 @Command
 public double myCommand(int value){..};
 

Possible parameter types and return types are:

boolean, boolean[], short, short[], long, long[], float, float[], double, double[], String, String[], int, int[], DeviceState, DeviceState[], byte, byte[], DevEncoded, DevVarLongStringArray, DevVarDoubleStringArray

Author:
ABEILLE

Optional Element Summary
 int displayLevel
          The command display level.
 java.lang.String inTypeDesc
           
 boolean isPolled
          define if attribute is polling.
 java.lang.String name
          Default name is method name
 java.lang.String outTypeDesc
          The command output documentation
 int pollingPeriod
          Configure polling period in ms.
 

name

public abstract java.lang.String name
Default name is method name

Returns:
The command name.
Default:
""

inTypeDesc

public abstract java.lang.String inTypeDesc
Default:
"Uninitialised"

outTypeDesc

public abstract java.lang.String outTypeDesc
The command output documentation

Returns:
output doc
Default:
"Uninitialised"

displayLevel

public abstract int displayLevel
The command display level. see @link DispLevel

Returns:
the display level
Default:
0

isPolled

public abstract boolean isPolled
define if attribute is polling. period must be configured. see Attribute.pollingPeriod()

Returns:
is polled
Default:
false

pollingPeriod

public abstract int pollingPeriod
Configure polling period in ms. use only is Attribute.isPolled() is true

Returns:
polling period
Default:
0


Copyright © 2012-2016. All Rights Reserved.