Classes | Public Types | Public Member Functions | List of all members
variant_topic_tools::MessageMemberPointer< T, M > Class Template Reference

Shared pointer. More...

#include <MessageMemberPointer.h>

Inheritance diagram for variant_topic_tools::MessageMemberPointer< T, M >:
Inheritance graph
[legend]

Classes

class  Impl
 Message member pointer implementation. More...
 

Public Types

typedef type_traits::DataType< M >::ValueType MemberValueType
 Definition of the message member value type. More...
 
typedef type_traits::MessageType< T >::ValueType ValueType
 Definition of the message value type. More...
 

Public Member Functions

 BOOST_STATIC_ASSERT (type_traits::IsMessage< T >::value)
 
const Pointer< ValueType > & getMessage () const
 Retrieve the message. More...
 
size_t getOffset () const
 Retrieve the message member offset. More...
 
 MessageMemberPointer (ValueType *message=0, size_t offset=0)
 Default constructor. More...
 
 MessageMemberPointer (const Pointer< ValueType > &message, size_t offset)
 Constructor (overloaded version taking a message pointer and an offset) More...
 
 MessageMemberPointer (const MessageMemberPointer< T, M > &src)
 Copy constructor. More...
 
 MessageMemberPointer (const Pointer< MemberValueType > &src)
 Copy constructor (overloaded version taking a pointer) More...
 
void setMessage (const Pointer< ValueType > &message)
 Set the message. More...
 
void setOffset (size_t offset)
 Set the message member offset. More...
 
 ~MessageMemberPointer ()
 Destructor. More...
 
- Public Member Functions inherited from variant_topic_tools::Pointer< type_traits::DataType< M >::ValueType >
type_traits::DataType< M >::ValueType * get () const
 Retrieve the stored pointer. More...
 
 operator void * () const
 Void pointer conversion. More...
 
bool operator!= (const Pointer< type_traits::DataType< M >::ValueType > &pointer) const
 Inequality comparison operator. More...
 
type_traits::DataType< M >::ValueType & operator* () const
 Reference operator. More...
 
type_traits::DataType< M >::ValueType * operator-> () const
 Pointer operator. More...
 
bool operator== (const Pointer< type_traits::DataType< M >::ValueType > &pointer) const
 Equality comparison operator. More...
 
 Pointer (type_traits::DataType< M >::ValueType *pointer=0)
 Default constructor. More...
 
 Pointer (const Pointer< type_traits::DataType< M >::ValueType > &src)
 Copy constructor. More...
 
void reset ()
 Reset this pointer. More...
 
 ~Pointer ()
 Destructor. More...
 

Additional Inherited Members

- Protected Types inherited from variant_topic_tools::Pointer< type_traits::DataType< M >::ValueType >
typedef boost::shared_ptr< ImplA > ImplPtr
 Declaration of the pointer implementation pointer type. More...
 
typedef boost::weak_ptr< ImplA > ImplWPtr
 Declaration of the pointer implementation weak pointer type. More...
 
- Protected Attributes inherited from variant_topic_tools::Pointer< type_traits::DataType< M >::ValueType >
ImplPtr impl
 The pointer's implementation. More...
 

Detailed Description

template<typename T, typename M>
class variant_topic_tools::MessageMemberPointer< T, M >

Shared pointer.

Definition at line 33 of file MessageMemberPointer.h.

Member Typedef Documentation

template<typename T, typename M>
typedef type_traits::DataType<M>::ValueType variant_topic_tools::MessageMemberPointer< T, M >::MemberValueType

Definition of the message member value type.

Definition at line 44 of file MessageMemberPointer.h.

template<typename T, typename M>
typedef type_traits::MessageType<T>::ValueType variant_topic_tools::MessageMemberPointer< T, M >::ValueType

Definition of the message value type.

Definition at line 40 of file MessageMemberPointer.h.

Constructor & Destructor Documentation

template<typename T, typename M>
variant_topic_tools::MessageMemberPointer< T, M >::MessageMemberPointer ( ValueType message = 0,
size_t  offset = 0 
)

Default constructor.

template<typename T, typename M>
variant_topic_tools::MessageMemberPointer< T, M >::MessageMemberPointer ( const Pointer< ValueType > &  message,
size_t  offset 
)

Constructor (overloaded version taking a message pointer and an offset)

template<typename T, typename M>
variant_topic_tools::MessageMemberPointer< T, M >::MessageMemberPointer ( const MessageMemberPointer< T, M > &  src)

Copy constructor.

template<typename T, typename M>
variant_topic_tools::MessageMemberPointer< T, M >::MessageMemberPointer ( const Pointer< MemberValueType > &  src)

Copy constructor (overloaded version taking a pointer)

template<typename T, typename M>
variant_topic_tools::MessageMemberPointer< T, M >::~MessageMemberPointer ( )

Destructor.

Member Function Documentation

template<typename T, typename M>
variant_topic_tools::MessageMemberPointer< T, M >::BOOST_STATIC_ASSERT ( type_traits::IsMessage< T >::value  )
template<typename T, typename M>
const Pointer<ValueType>& variant_topic_tools::MessageMemberPointer< T, M >::getMessage ( ) const

Retrieve the message.

template<typename T, typename M>
size_t variant_topic_tools::MessageMemberPointer< T, M >::getOffset ( ) const

Retrieve the message member offset.

template<typename T, typename M>
void variant_topic_tools::MessageMemberPointer< T, M >::setMessage ( const Pointer< ValueType > &  message)

Set the message.

template<typename T, typename M>
void variant_topic_tools::MessageMemberPointer< T, M >::setOffset ( size_t  offset)

Set the message member offset.


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


variant_topic_tools
Author(s): Ralf Kaestner
autogenerated on Sat Jan 9 2021 03:56:50