org.lsst.ccs.command.annotations

Annotation Type Command

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

Annotation for commands. Allows to specify the name of a command, otherwise method's name is used.

Author:

turri

Field Summary

Fields

Modifier and Type	Fields and Description
static int	ENGINEERING1
static int	ENGINEERING2
static int	ENGINEERING3
static int	NORMAL
static int	NOT_DEFINED

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	alias Specify aliases for the command.
boolean	autoAck Returns true if the ACK should be automatically sent by the framework before invoking this command.
Command.CommandCategory	category
String	description Specify the description of the command.
int	level Specify the level of the command.
String	name If not null it will replace the method's name as the command name.
boolean	simulation Is this a command for simulation only? Simulation only commands will be added to the object's dictionary only when property org.lsst.ccs.run.mode is set to "true".
int	timeout Timeout for the command in seconds.
Command.CommandType	type The CommandType of the Command

Field Detail

NORMAL

public static final int NORMAL

ENGINEERING1

public static final int ENGINEERING1

ENGINEERING2

public static final int ENGINEERING2

ENGINEERING3

public static final int ENGINEERING3

NOT_DEFINED

public static final int NOT_DEFINED

Element Detail

name

public abstract String name

If not null it will replace the method's name as the command name.

Returns:

"" or null if default name is used, user-specified name otherwise.

Default:

""

description

public abstract String description

Specify the description of the command.

Returns:

command's description or "" if not set.

Default:

""

alias

public abstract String alias

Specify aliases for the command. Multiple aliases can be specified as a comma separated list.

Returns:

command's abbreviation(s) or "" if not set.

Default:

""

type

public abstract Command.CommandType type

The CommandType of the Command

Returns:

The command type.

Default:

org.lsst.ccs.command.annotations.Command.CommandType.ACTION

level

public abstract int level

Specify the level of the command. Only locks at the given level, or higher will have access to the command.

Returns:

the level of the Command. The default is NOT_DEFINED.

Default:

99999

category

public abstract Command.CommandCategory category

Returns:

Whether this is a system command or not

Default:

org.lsst.ccs.command.annotations.Command.CommandCategory.USER

autoAck

public abstract boolean autoAck

Returns true if the ACK should be automatically sent by the framework before invoking this command.

Returns:

true if the ACK should be automatically generated.

Default:

true

timeout

public abstract int timeout

Timeout for the command in seconds. Non-positive value indicates that the default timeout of the command originator should be used.

Returns:

Timeout value in seconds.

Default:

0

simulation

public abstract boolean simulation

Is this a command for simulation only? Simulation only commands will be added to the object's dictionary only when property org.lsst.ccs.run.mode is set to "true".

Returns:

Timeout value in seconds.

Default:

false