Tango::TemplCommandOut< OUTARG > Class Template Reference

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

#include <command.h>

Inheritance diagram for Tango::TemplCommandOut< OUTARG >:

List of all members.

Public Member Functions
Constructors
Miscellaneous constructors
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)())
	Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method.
	TemplCommandOut (string &cmd_name, OUTARG(DeviceImpl::*exe_method)())
	Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method.
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), bool(DeviceImpl::*state_method)(const CORBA::Any &))
	Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method.
	TemplCommandOut (string &cmd_name, OUTARG(DeviceImpl::*exe_method)(), bool(DeviceImpl::*state_method)(const CORBA::Any &))
	Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method.
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), const char *in_desc, const char *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.
	TemplCommandOut (string &cmd_name, OUTARG(DeviceImpl::*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.
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), bool(DeviceImpl::*state_method)(const CORBA::Any &), const char *in_desc, const char *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 &cmd_name, OUTARG(DeviceImpl::*exe_method)(), 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.
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), Tango::DispLevel level)
	Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method.
	TemplCommandOut (string &cmd_name, OUTARG(DeviceImpl::*exe_method)(), Tango::DispLevel level)
	Constructs a newly allocated TemplCommandOut object for a command with a name and an execution method.
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), bool(DeviceImpl::*state_method)(const CORBA::Any &), Tango::DispLevel level)
	Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method.
	TemplCommandOut (string &cmd_name, OUTARG(DeviceImpl::*exe_method)(), bool(DeviceImpl::*state_method)(const CORBA::Any &), Tango::DispLevel level)
	Constructs a newly allocated TemplCommandOut object for a command with a name, an execution method and a command allowed method.
	TemplCommandOut (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), const char *in_desc, const char *out_desc, Tango::DispLevel level)
	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 &cmd_name, OUTARG(DeviceImpl::*exe_method)(), string &in_desc, string &out_desc, Tango::DispLevel level)
	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 (const char *cmd_name, OUTARG(DeviceImpl::*exe_method)(), bool(DeviceImpl::*state_method)(const CORBA::Any &), const char *in_desc, const char *out_desc, Tango::DispLevel level)
	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 &cmd_name, OUTARG(DeviceImpl::*exe_method)(), 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 OUTARG>
class Tango::TemplCommandOut< OUTARG >

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

The class template parameter (called OUTARG) is the command output parameter type.

Synopsis : template <typename outarg>=""> class TemplCommandOut:public TemplCommand;

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

Author

taurel

Revision

15556

---

Constructor & Destructor Documentation

template<typename OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	const char *	cmd_name,
		OUTARG(DeviceImpl::*)()	exe_method
	)			[inline]

Constructs a newly allocated TemplCommandOut 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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	string &	cmd_name,
		OUTARG(DeviceImpl::*)()	exe_method
	)			[inline]

Constructs a newly allocated TemplCommandOut 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 OUTARG >

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

Constructs a newly allocated TemplCommandOut 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 OUTARG >

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

Constructs a newly allocated TemplCommandOut 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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	const char *	cmd_name,
		OUTARG(DeviceImpl::*)()	exe_method,
		const char *	in_desc,
		const char *	out_desc
	)			[inline]

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 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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	string &	cmd_name,
		OUTARG(DeviceImpl::*)()	exe_method,
		string &	in_desc,
		string &	out_desc
	)			[inline]

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 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 OUTARG >

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

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.

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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	string &	cmd_name,
		OUTARG(DeviceImpl::*)()	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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	const char *	cmd_name,
		OUTARG(DeviceImpl::*)()	exe_method,
		Tango::DispLevel	level
	)			[inline]

Constructs a newly allocated TemplCommandOut 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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	string &	cmd_name,
		OUTARG(DeviceImpl::*)()	exe_method,
		Tango::DispLevel	level
	)			[inline]

Constructs a newly allocated TemplCommandOut 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 OUTARG >

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

Constructs a newly allocated TemplCommandOut 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 OUTARG >

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

Constructs a newly allocated TemplCommandOut 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 OUTARG >

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

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 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 OUTARG >

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

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 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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	const char *	cmd_name,
		OUTARG(DeviceImpl::*)()	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 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.

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 OUTARG >

Tango::TemplCommandOut< OUTARG >::TemplCommandOut	(	string &	cmd_name,
		OUTARG(DeviceImpl::*)()	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 OUTARG >

CORBA::Any * Tango::TemplCommandOut< OUTARG >::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 invokes the user supplied command execution method and packs the returned data into the outgoing CORBA Any object

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.

Exceptions:

DevFailed

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

Reimplemented from Tango::TemplCommand.

template<typename OUTARG >

void Tango::TemplCommandOut< OUTARG >::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