template class TemplCommandIn : public TemplCommand

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

Inheritance:


Public

Constructors
TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG))
Constructs a newly allocated TemplCommandIn object for a command with a name and an execution method
TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG))
Constructs a newly allocated TemplCommandIn object for a command with a name and an execution method
TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &))
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a command allowed method
TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &))
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a command allowed method
TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG), const char *in_desc, const char *out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a description for the input and output command parameters
TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG), string &in_desc, string &out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a description for the input and output command parameters
TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &), const char *in_desc, const char *out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters
TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &), string &in_desc, string &out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters
Miscellaneous methods
void init_types()
Initialise command input and output types
CORBA::Any* execute(DeviceImpl *dev, const CORBA::Any &in_any)
Invoke the command execution method given at object creation time

Documentation

This class is a class representing a command in the template command model with input parameter but without output parameter. The class template parameter (called INARG) is the command input parameter type.

Synopsis : template <class INARG> class TemplCommandIn:public TemplCommand;

Usage : new TemplCommandIn<Tango::DevLong>(...);

Constructors
Miscellaneous constructors

TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG))
Constructs a newly allocated TemplCommandIn object for a command with a name and an execution method. The input and output command data type are automatically determined. The input and output parameter description are set to the default String "Uninitialised".
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method

TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG))
Constructs a newly allocated TemplCommandIn object for a command with a name and an execution method. The input and output command data type are automatically determined. The input and output parameter description are set to the default String "Uninitialised".
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method

TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &))
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a command allowed method. The input and output command data type are automatically determined. The input and output parameter description are set to the default String "Uninitialised".
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method
state_method - Pointer to the command allowed method

TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &))
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a command allowed method. The input and output command data type are automatically determined. The input and output parameter description are set to the default String "Uninitialised".
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method
state_method - Pointer to the command allowed method

TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG), const char *in_desc, const char *out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a description for the input and output command parameters. The input and output command data type are automatically determined.
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method
in_desc - The command input parameter description
out_desc - The command output parameter description

TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG), string &in_desc, string &out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method and a description for the input and output command parameters. The input and output command data type are automatically determined.
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method
in_desc - The command input parameter description
out_desc - The command output parameter description

TemplCommandIn(const char *cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &), const char *in_desc, const char *out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters. The input and output command data type are automatically determined.
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method
state_method - Pointer to the command allowed method
in_desc - The command input parameter description
out_desc - The command output parameter description

TemplCommandIn(string &cmd_name, void (DeviceImpl::*exe_method)(INARG), bool (DeviceImpl::*state_method)(const CORBA::Any &), string &in_desc, string &out_desc)
Constructs a newly allocated TemplCommandIn object for a command with a name, an execution method, a command allowed method and a description for the input and output command parameters. The input and output command data type are automatically determined.
Parameters:
cmd_name - The command name
exe_method - Pointer to the command execution method
state_method - Pointer to the command allowed method
in_desc - The command input parameter description
out_desc - The command output parameter description

Miscellaneous methods

void init_types()
Initialise command input and output types. Set the command output type to Tango::DEV_VOID. The command input type is automatically determined from the class template specialisation

CORBA::Any* execute(DeviceImpl *dev, const CORBA::Any &in_any)
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 unpacks the data stored in the CORBA Any object and invoke the user supplied command execution method
Throws:
DevFailed If the execution method failed Click here to read DevFailed exception specification
Returns:
The CORBA Any object returned to the client. For command created with this TemplCommandIn class, this any object does not contain data.
Parameters:
dev - The device on which the command must be executed
in_any - The incoming data still packed in a CORBA Any object.


This class has no child classes.
Author:
$Author: taurel $
Version:
$Revision: 1.3 $

alphabetic index hierarchy of classes


generated by doc++