Public Types | Static Public Member Functions | List of all members
RTT::corba::AnyConversion< Type > Struct Template Reference

#include <CorbaConversion.hpp>

Public Types

typedef CORBA::Any CorbaType
 
typedef RTT::corba::CAnySequence sequence
 
typedef Type StdType
 

Static Public Member Functions

static CORBA::Any_ptr createAny (StdType tp)
 
static bool toCorbaType (CorbaType &cb, const StdType &tp)
 
static bool toStdType (StdType &tp, const CorbaType &cb)
 
static bool update (const CORBA::Any &any, StdType tp)
 
static bool updateAny (StdType tp, CORBA::Any &any)
 

Detailed Description

template<class Type>
struct RTT::corba::AnyConversion< Type >

This class converts a given application-specific type to a CORBA::Any object and vice versa. This class works with 'template specialisation'. To create your own any conversion, specialise this class for your application's C++ or IDL type. Also, your specialisation must be in the RTT namespace in order to be found by the CORBA-enabled classes such as Property or the TaskContext.

Parameters
Typeis the Standard C++ or IDL type which is used throughout your application.

Definition at line 81 of file CorbaConversion.hpp.

Member Typedef Documentation

template<class Type>
typedef CORBA::Any RTT::corba::AnyConversion< Type >::CorbaType

corba type

Definition at line 86 of file CorbaConversion.hpp.

template<class Type>
typedef RTT::corba::CAnySequence RTT::corba::AnyConversion< Type >::sequence

sequence of corba type (used to convert stl container)

Definition at line 94 of file CorbaConversion.hpp.

template<class Type>
typedef Type RTT::corba::AnyConversion< Type >::StdType

C++ type

Definition at line 90 of file CorbaConversion.hpp.

Member Function Documentation

template<class Type>
static CORBA::Any_ptr RTT::corba::AnyConversion< Type >::createAny ( StdType  tp)
inlinestatic

Creates an CORBA::Any object out of a C++/IDL type.

Parameters
tpThe value to convert to an Any.
Returns
An Any object which contains tp or an empty Any object if the conversion was not possible.

Definition at line 138 of file CorbaConversion.hpp.

template<class Type>
static bool RTT::corba::AnyConversion< Type >::toCorbaType ( CorbaType cb,
const StdType tp 
)
inlinestatic

Updates cb with the contents of tp.

Parameters
cbA CORBA type in which the contents of the tp are written.
tpContains possibly data of a type convertible to cb
Returns
true if the tp was convertible to cb.

Definition at line 115 of file CorbaConversion.hpp.

template<class Type>
static bool RTT::corba::AnyConversion< Type >::toStdType ( StdType tp,
const CorbaType cb 
)
inlinestatic

Updates tp with the contents of cb.

Parameters
tpA C++ or CORBA type in which the contents of the cb are written.
cbContains possibly data of a type convertible to tp
Returns
true if the cb was convertible to tp.

Definition at line 103 of file CorbaConversion.hpp.

template<class Type>
static bool RTT::corba::AnyConversion< Type >::update ( const CORBA::Any &  any,
StdType  tp 
)
inlinestatic

Updates tp with the contents of any.

Parameters
anyContains possibly data of a type convertible to tp
tpA C++ or CORBA type in which the contents of the any are written.
Returns
true if the any was convertible to tp.

Definition at line 127 of file CorbaConversion.hpp.

template<class Type>
static bool RTT::corba::AnyConversion< Type >::updateAny ( StdType  tp,
CORBA::Any &  any 
)
inlinestatic

Updates an CORBA::Any object from of a C++/IDL type.

Parameters
tpThe value to convert to the Any.
AnAny object which will contain tp or an empty Any object if the conversion was not possible.
Returns
false if no conversion could be made

Definition at line 150 of file CorbaConversion.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:42