namespace Tango class Command

This class is a class representing a command in the TANGO device server pattern

Inheritance:


Public

Constructors
Command()
Constructs a newly allocated Command object
Command(const char *s, Tango::CmdArgType in, Tango::CmdArgType out)
Constructs a newly allocated Command object for a command from its name and its input and output parameter types
Command(string &s, Tango::CmdArgType in, Tango::CmdArgType out)
Constructs a newly allocated Command object for a command from its name and its input and output parameter types
Command(const char *s, Tango::CmdArgType in, Tango::CmdArgType out, const char *in_desc, const char *out_desc)
Constructs a newly allocated Command object for a command from its name, its input and output parameter types plus parameters description
Command(string &s, Tango::CmdArgType in, Tango::CmdArgType out, string &in_desc, string &out_desc)
Constructs a newly allocated Command object for a command from its name, its input and output parameter types plus parameters description
Destructor
virtual ~Command()
The object desctructor
Miscellaneous methods
virtual CORBA::Any* execute(DeviceImpl *dev, const CORBA::Any &in_any)
Execute the command
virtual bool is_allowed(DeviceImpl *, const CORBA::Any &)
Check if the command is allowed in the actual device state
virtual void init_types()
Init command parameters type
Get/Set object members.
string& get_name()
Return the command name
Tango::CmdArgType get_in_type()
Return the input parameter type
Tango::CmdArgType get_out_type()
Return the output parameter type
string& get_in_type_desc()
Return the input parameter description
string& get_out_type_desc()
Return the output parameter description
void set_in_type_desc(const char *desc)
Set the input parameter description field
void set_in_type_desc(string &desc)
Set the input parameter description field
void set_out_type_desc(const char *desc)
Set the output parameter description field
void set_out_type_desc(string &desc)
Set the output parameter description field
Extract methods.
void extract(const CORBA::Any &in, Tango::DevBoolean &data)
Extract a boolean data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevShort &data)
Extract a short data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevLong &data)
Extract a long data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevFloat &data)
Extract a float data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevDouble &data)
Extract a double data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevUShort &data)
Extract an unsigned short data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevULong &data)
Extract an unsigned long data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevString &data)
Extract a string from a CORBA Any object
void extract(const CORBA::Any &in, const char *&data)
Extract a const string from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarCharArray *&data)
Extract a char array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarShortArray *&data)
Extract a short array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarLongArray *&data)
Extract a long array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarFloatArray *&data)
Extract a float array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarDoubleArray *&data)
Extract a double array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarUShortArray *&data)
Extract a unsigned short array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarULongArray *&data)
Extract a unsigned long array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarStringArray *&data)
Extract a string array from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarLongStringArray *&data)
Extract a DevVarLongStringArray data from a CORBA Any object
void extract(const CORBA::Any &in, const Tango::DevVarDoubleStringArray *&data)
Extract a DevVarDoubleStringArray data from a CORBA Any object
void extract(const CORBA::Any &in, Tango::DevState &data)
Extract a Tango device state data from a CORBA Any object
Insert methods.
CORBA::Any* insert()
Create an empty CORBA Any object
CORBA::Any* insert(Tango::DevBoolean data)
Create a CORBA Any object and insert a Tango::DevBoolean data in it
CORBA::Any* insert(Tango::DevShort data)
Create a CORBA Any object and insert a Tango::DevShort data in it
CORBA::Any* insert(Tango::DevLong data)
Create a CORBA Any object and insert a Tango::DevLong data in it
CORBA::Any* insert(Tango::DevFloat data)
Create a CORBA Any object and insert a Tango::DevFloat data in it
CORBA::Any* insert(Tango::DevDouble data)
Create a CORBA Any object and insert a Tango::DevDouble data in it
CORBA::Any* insert(Tango::DevUShort data)
Create a CORBA Any object and insert a Tango::DevUShort data in it
CORBA::Any* insert(Tango::DevULong data)
Create a CORBA Any object and insert a Tango::DevULong data in it
CORBA::Any* insert(Tango::DevString data)
Create a CORBA Any object and insert a Tango::DevString data in it
CORBA::Any* insert(const char *data)
Create a CORBA Any object and insert a Tango::DevString data in it
CORBA::Any* insert(Tango::DevVarCharArray &data)
Create a CORBA Any object and insert a Tango::DevVarCharArray data in it
CORBA::Any* insert(Tango::DevVarCharArray *data)
Create a CORBA Any object and insert a Tango::DevVarCharArray data in it
CORBA::Any* insert(Tango::DevVarShortArray &data)
Create a CORBA Any object and insert a Tango::DevVarShortArray data in it
CORBA::Any* insert(Tango::DevVarShortArray *data)
Create a CORBA Any object and insert a Tango::DevVarShortArray data in it
CORBA::Any* insert(Tango::DevVarLongArray &data)
Create a CORBA Any object and insert a Tango::DevVarLongArray data in it
CORBA::Any* insert(Tango::DevVarLongArray *data)
Create a CORBA Any object and insert a Tango::DevVarLongArray data in it
CORBA::Any* insert(Tango::DevVarFloatArray &data)
Create a CORBA Any object and insert a Tango::DevVarFloatArray data in it
CORBA::Any* insert(Tango::DevVarFloatArray *data)
Create a CORBA Any object and insert a Tango::DevVarFloatArray data in it
CORBA::Any* insert(Tango::DevVarDoubleArray &data)
Create a CORBA Any object and insert a Tango::DevVarDoubleArray data in it
CORBA::Any* insert(Tango::DevVarDoubleArray *data)
Create a CORBA CORBA::Any object and insert a Tango::DevVarDoubleArray data in it
CORBA::Any* insert(Tango::DevVarUShortArray &data)
Create a CORBA Any object and insert a Tango::DevVarUShortArray data in it
CORBA::Any* insert(Tango::DevVarUShortArray *data)
Create a CORBA Any object and insert a Tango::DevVarUShortArray data in it
CORBA::Any* insert(Tango::DevVarULongArray &data)
Create a CORBA Any object and insert a Tango::DevVarULongArray data in it
CORBA::Any* insert(Tango::DevVarULongArray *data)
Create a CORBA Any object and insert a Tango::DevVarULongArray data in it
CORBA::Any* insert(Tango::DevVarStringArray &data)
Create a CORBA Any object and insert a Tango::DevVarStringArray data in it
CORBA::Any* insert(Tango::DevVarStringArray *data)
Create a CORBA Any object and insert a Tango::DevVarStringArray data in it
CORBA::Any* insert(Tango::DevVarLongStringArray &data)
Create a CORBA Any object and insert a Tango::DevVarLongStringArray data in it
CORBA::Any* insert(Tango::DevVarLongStringArray *data)
Create a CORBA Any object and insert a Tango::DevVarLongStringArray data in it
CORBA::Any* insert(Tango::DevVarDoubleStringArray &data)
Create a CORBA Any object and insert a Tango::DevVarDoubleStringArray data in it
CORBA::Any* insert(Tango::DevVarDoubleStringArray *data)
Create a CORBA Any object and insert a Tango::DevVarDoubleStringArray data in it
CORBA::Any* insert(Tango::DevState)
Create a CORBA Any object and insert a Tango::DevState data in it

Protected

Class data members
string name
The command name
Tango::CmdArgType in_type
The command input parameter type
Tango::CmdArgType out_type
The command output parameter type
string in_type_desc
The command input parameter description
string out_type_desc
The command output parameter type

Documentation

This class is a class representing a command in the TANGO device server pattern. it is an abstract class. It is the root class for all command related classes for command implemented with the inheritance model or with the template command model
Constructors
Miscellaneous constructors

Command()
Constructs a newly allocated Command object. The default constructor

Command(const char *s, Tango::CmdArgType in, Tango::CmdArgType out)
Constructs a newly allocated Command object for a command from its name and its input and output parameter types. The input and output parameter description are set to the default String "Uninitialised".
Parameters:
s - The command name
in - The command input parameter type
out - The command output parameter type

Command(string &s, Tango::CmdArgType in, Tango::CmdArgType out)
Constructs a newly allocated Command object for a command from its name and its input and output parameter types. The input and output parameter description are set to the default String "Uninitialised".
Parameters:
s - The command name
in - The command input parameter type
out - The command output parameter type

Command(const char *s, Tango::CmdArgType in, Tango::CmdArgType out, const char *in_desc, const char *out_desc)
Constructs a newly allocated Command object for a command from its name, its input and output parameter types plus parameters description
Parameters:
s - The command name
in - The command input parameter type
out - The command output parameter type
in_desc - The input parameter description
out_desc - The output parameter description

Command(string &s, Tango::CmdArgType in, Tango::CmdArgType out, string &in_desc, string &out_desc)
Constructs a newly allocated Command object for a command from its name, its input and output parameter types plus parameters description
Parameters:
s - The command name
in - The command input parameter type
out - The command output parameter type
in_desc - The input parameter description
out_desc - The output parameter description

Destructor
Only one desctructor is defined for this class

virtual ~Command()
The object desctructor

Miscellaneous methods

virtual CORBA::Any* execute(DeviceImpl *dev, const CORBA::Any &in_any)
Execute the command. This method is automtically called by the TANGO core classes when the associated command is requested by a client. This method is abstract and must be redefined in each sub-class
Throws:
DevFailed If the execution method failed. Click here to read DevFailed exception specification
Returns:
The CORBA Any object returned to the client.
Parameters:
dev - The device on which the command must be executed
in_any - The incoming data still packed in a CORBA Any object.

virtual bool is_allowed(DeviceImpl *, const CORBA::Any &)
Check if the command is allowed in the actual device state. This method is automtically called by the TANGO core classes when the associated command is requested by a client to check if the command is allowed in the actual device state. This method is the default is_allowed method which always allows the command to be executed. It is possible to re-define it if this default behaviour does not fullfill the device needs.
Returns:
A boolean set to true is the command is allowed. Otherwise, the return value is false.
Parameters:
dev - The device on which the command must be executed
in_any - The incoming data still packed in a CORBA Any object. This data is passed to this method in case it is necessary to take the command allowed decision

virtual void init_types()
Init command parameters type. This method is used only for command implemented using the Tango template command model. In this base class, it does nothing and is re-define in sub-classes.

Get/Set object members.
These methods allows the external world to get/set DeviceImpl instance data members

string& get_name()
Return the command name.
Returns:
The command name

Tango::CmdArgType get_in_type()
Return the input parameter type.
Returns:
The input parameter type

Tango::CmdArgType get_out_type()
Return the output parameter type.
Returns:
The output parameter type

string& get_in_type_desc()
Return the input parameter description.
Returns:
The input parameter description

string& get_out_type_desc()
Return the output parameter description.
Returns:
The output parameter description

void set_in_type_desc(const char *desc)
Set the input parameter description field.
Parameters:
type - The input parameter description

void set_in_type_desc(string &desc)
Set the input parameter description field.
Parameters:
type - The input parameter description

void set_out_type_desc(const char *desc)
Set the output parameter description field.
Parameters:
type - The output parameter description

void set_out_type_desc(string &desc)
Set the output parameter description field.
Parameters:
type - The output parameter description

Extract methods.
All these methods extract data from the CORBA Any object received as command input data

void extract(const CORBA::Any &in, Tango::DevBoolean &data)
Extract a boolean data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted boolean data

void extract(const CORBA::Any &in, Tango::DevShort &data)
Extract a short data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted short data

void extract(const CORBA::Any &in, Tango::DevLong &data)
Extract a long data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted long data

void extract(const CORBA::Any &in, Tango::DevFloat &data)
Extract a float data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted float data

void extract(const CORBA::Any &in, Tango::DevDouble &data)
Extract a double data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted double data

void extract(const CORBA::Any &in, Tango::DevUShort &data)
Extract an unsigned short data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contanis a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted unsigned short data

void extract(const CORBA::Any &in, Tango::DevULong &data)
Extract an unsigned long data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contanis a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted unsigned long data

void extract(const CORBA::Any &in, Tango::DevString &data)
Extract a string from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted string data

void extract(const CORBA::Any &in, const char *&data)
Extract a const string from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted string data

void extract(const CORBA::Any &in, const Tango::DevVarCharArray *&data)
Extract a char array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted char array

void extract(const CORBA::Any &in, const Tango::DevVarShortArray *&data)
Extract a short array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted short array

void extract(const CORBA::Any &in, const Tango::DevVarLongArray *&data)
Extract a long array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted long array

void extract(const CORBA::Any &in, const Tango::DevVarFloatArray *&data)
Extract a float array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted float array

void extract(const CORBA::Any &in, const Tango::DevVarDoubleArray *&data)
Extract a double array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted double array

void extract(const CORBA::Any &in, const Tango::DevVarUShortArray *&data)
Extract a unsigned short array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted unsigned char array

void extract(const CORBA::Any &in, const Tango::DevVarULongArray *&data)
Extract a unsigned long array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted unsigned long array

void extract(const CORBA::Any &in, const Tango::DevVarStringArray *&data)
Extract a string array from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted string array

void extract(const CORBA::Any &in, const Tango::DevVarLongStringArray *&data)
Extract a DevVarLongStringArray data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted DevVarLongStringArray data

void extract(const CORBA::Any &in, const Tango::DevVarDoubleStringArray *&data)
Extract a DevVarDoubleStringArray data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted DevVarDoubleStringArray data

void extract(const CORBA::Any &in, Tango::DevState &data)
Extract a Tango device state data from a CORBA Any object.
Throws:
DevFailed If the Any object does not contains a data of the waited type. Click here to read DevFailed exception specification
Parameters:
in - The CORBA Any object
data - Reference to the extracted device state data

Insert methods.
All these methods create a CORBA Any object and insert data into this object

CORBA::Any* insert()
Create an empty CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification

CORBA::Any* insert(Tango::DevBoolean data)
Create a CORBA Any object and insert a Tango::DevBoolean data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevShort data)
Create a CORBA Any object and insert a Tango::DevShort data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevLong data)
Create a CORBA Any object and insert a Tango::DevLong data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevFloat data)
Create a CORBA Any object and insert a Tango::DevFloat data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevDouble data)
Create a CORBA Any object and insert a Tango::DevDouble data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevUShort data)
Create a CORBA Any object and insert a Tango::DevUShort data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevULong data)
Create a CORBA Any object and insert a Tango::DevULong data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

CORBA::Any* insert(Tango::DevString data)
Create a CORBA Any object and insert a Tango::DevString data in it. This method will also de-allocate the string passed as parameter.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The string to be inserted into the Any object

CORBA::Any* insert(const char *data)
Create a CORBA Any object and insert a Tango::DevString data in it. Te parameter type is char * and not Tango::DevString because the const C++ modifier applied to a Tango::DevString make the pointer constant and not the pointed to characters to be constant.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The string to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarCharArray &data)
Create a CORBA Any object and insert a Tango::DevVarCharArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarCharArray *data)
Create a CORBA Any object and insert a Tango::DevVarCharArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarCharArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarShortArray &data)
Create a CORBA Any object and insert a Tango::DevVarShortArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarShortArray *data)
Create a CORBA Any object and insert a Tango::DevVarShortArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarShortArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarLongArray &data)
Create a CORBA Any object and insert a Tango::DevVarLongArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarLongArray *data)
Create a CORBA Any object and insert a Tango::DevVarLongArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarLongArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarFloatArray &data)
Create a CORBA Any object and insert a Tango::DevVarFloatArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarFloatArray *data)
Create a CORBA Any object and insert a Tango::DevVarFloatArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarFloatArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarDoubleArray &data)
Create a CORBA Any object and insert a Tango::DevVarDoubleArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarDoubleArray *data)
Create a CORBA CORBA::Any object and insert a Tango::DevVarDoubleArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarDoubleArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarUShortArray &data)
Create a CORBA Any object and insert a Tango::DevVarUShortArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarUShortArray *data)
Create a CORBA Any object and insert a Tango::DevVarUShortArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarUShortArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarULongArray &data)
Create a CORBA Any object and insert a Tango::DevVarULongArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarULongArray *data)
Create a CORBA Any object and insert a Tango::DevVarULongArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarULongArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarStringArray &data)
Create a CORBA Any object and insert a Tango::DevVarStringArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarStringArray *data)
Create a CORBA Any object and insert a Tango::DevVarStringArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarStringArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarLongStringArray &data)
Create a CORBA Any object and insert a Tango::DevVarLongStringArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarLongStringArray *data)
Create a CORBA Any object and insert a Tango::DevVarLongStringArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarLongStringArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarDoubleStringArray &data)
Create a CORBA Any object and insert a Tango::DevVarDoubleStringArray data in it. This method will do a deep copy of the array into the Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevVarDoubleStringArray *data)
Create a CORBA Any object and insert a Tango::DevVarDoubleStringArray data in it. This method consumes the memory used by the array. When the CORBA layer will destroy the Any object, the memory alloacted for the array will also be freed. This is the recommended method to insert Tango::DevVarDoubleStringArray data type into a CORBA Any object.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The array to be inserted into the Any object

CORBA::Any* insert(Tango::DevState)
Create a CORBA Any object and insert a Tango::DevState data in it.
Throws:
DevFailed If the Any object creation failed. Click here to read DevFailed exception specification
Parameters:
data - The data to be inserted into the Any object

Class data members

string name
The command name

Tango::CmdArgType in_type
The command input parameter type

Tango::CmdArgType out_type
The command output parameter type

string in_type_desc
The command input parameter description

string out_type_desc
The command output parameter type


Direct child classes:
TemplCommand
Author:
$Author: taurel $
Version:
$Revision: 1.3 $

alphabetic index hierarchy of classes


generated by doc++