Tango::TemplCommandIn< INARG > Class Template Reference

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

#include <command.h>

Inheritance diagram for Tango::TemplCommandIn< INARG >:

List of all members.

Public Member Functions
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.
	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.
	TemplCommandIn (const char *cmd_name, void(DeviceImpl::*exe_method)(INARG), Tango::DispLevel level)
	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), Tango::DispLevel level)
	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 &), Tango::DispLevel level)
	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 &), Tango::DispLevel level)
	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, Tango::DispLevel level)
	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, Tango::DispLevel level)
	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, Tango::DispLevel level)
	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, Tango::DispLevel level)
	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.

---

Detailed Description

template<typename INARG>
class Tango::TemplCommandIn< INARG >

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 <typename inarg>=""> class TemplCommandIn:public TemplCommand;

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

Author

taurel

Revision

15556

---

Constructor & Destructor Documentation

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method
	)			[inline]

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". The command display level is set to OPERATOR.

Parameters:

	cmd_name	The command name
	exe_method	Pointer to the command execution method

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method
	)			[inline]

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". The command display level is set to OPERATOR.

Parameters:

	cmd_name	The command name
	exe_method	Pointer to the command execution method

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method
	)			[inline]

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". The command display level is set to OPERATOR.

Parameters:

	cmd_name	The command name
	exe_method	Pointer to the command execution method
	state_method	Pointer to the command allowed method

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method
	)			[inline]

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". The command display level is set to OPERATOR.

Parameters:

	cmd_name	The command name
	exe_method	Pointer to the command execution method
	state_method	Pointer to the command allowed method

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		const char *	in_desc,
		const char *	out_desc
	)			[inline]

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. The command display level is set to OPERATOR.

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

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		string &	in_desc,
		string &	out_desc
	)			[inline]

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. The command display level is set to OPERATOR.

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

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method,
		const char *	in_desc,
		const char *	out_desc
	)			[inline]

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. The command display level is set to OPERATOR.

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

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method,
		string &	in_desc,
		string &	out_desc
	)			[inline]

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. The command display level is set to OPERATOR.

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

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		const char *	in_desc,
		const char *	out_desc,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		string &	in_desc,
		string &	out_desc,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	const char *	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method,
		const char *	in_desc,
		const char *	out_desc,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

template<typename INARG >

Tango::TemplCommandIn< INARG >::TemplCommandIn	(	string &	cmd_name,
		void(DeviceImpl::*)(INARG)	exe_method,
		bool(DeviceImpl::*)(const CORBA::Any &)	state_method,
		string &	in_desc,
		string &	out_desc,
		Tango::DispLevel	level
	)			[inline]

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
	level	The command display level

---

Member Function Documentation

template<typename INARG >

CORBA::Any * Tango::TemplCommandIn< INARG >::execute	(	DeviceImpl *	dev,
		const CORBA::Any &	in_any
	)			[inline, virtual]

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

Parameters:

	dev	The device on which the command must be executed
	in_any	The incoming data still packed in a CORBA Any object.

Returns:

The CORBA Any object returned to the client. For command created with this TemplCommandIn class, this any object does not contain data.

Exceptions:

DevFailed

If the execution method failed Click here to read DevFailed exception specification

Reimplemented from Tango::TemplCommand.

template<typename INARG >

void Tango::TemplCommandIn< INARG >::init_types

(

)

[inline, virtual]

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

Reimplemented from Tango::Command.

---

The documentation for this class was generated from the following file:

• command.h