RTT::types::carray< T > Class Template Reference

Wraps a C array such that we can return a C array from a DataSource. More...

#include <rtt/types/carray.hpp>

List of all members.

Public Types
typedef T	value_type
Public Member Functions
	carray (value_type *t, std::size_t s)
	Create an C array wrapper.
	carray ()
	Creates an empty carray.
	carray (boost::serialization::array< T > const &orig)
	We are constructible from boost::serialization::array<T> Makes a shallow copy in order to keep the reference to the original data.
template<std::size_t N>
	carray (boost::array< T, N > &orig)
	We are constructible from boost::array<T,N> Makes a shallow copy in order to keep the reference to the original data.
void	init (value_type *t, std::size_t s)
	(Re-)initialize this carray to a new address and size.
value_type *	address () const
	The address of the first element of the array.
std::size_t	count () const
const carray< T > &	operator= (const carray< T > &orig)
	Assignment only copies max(this->count(), orig.count()) elements from orig to this object.

---

Detailed Description

template<class T>
class RTT::types::carray< T >

Wraps a C array such that we can return a C array from a DataSource.

Inspired on boost::serialization::array.

Default copy-constructible (shallow copy).

An assignment (operator=) makes a 'deep copy', while copy construction makes a 'shallow copy', where the copy refers to the same C array. This was chosen in the spirit of this class, where it keeps track of the original data, but when assigned from another carray, is meant as copying the data itself.

You can also point to parts of arrays. An uninitialized carray object returns null for both count() and address().

Parameters:

T	The data type of the array.

Definition at line 69 of file carray.hpp.

---

Constructor & Destructor Documentation

template<class T>

RTT::types::carray< T >::carray	(	value_type *	t,
		std::size_t	s
	)		[inline]

Create an C array wrapper.

Parameters:

t	Pointer to first element of array.
s	Length of array. If zero, the parameter t will be ignored.

Definition at line 80 of file carray.hpp.

template<class T>

RTT::types::carray< T >::carray

(

)

[inline]

Creates an empty carray.

You are not allowed to read or write (operator=) to this array until it has been initialized.

See also:

init() in order to initialize it later on.

Definition at line 91 of file carray.hpp.

template<class T>

RTT::types::carray< T >::carray

(

boost::serialization::array< T > const &

orig

)

[inline]

We are constructible from boost::serialization::array<T> Makes a shallow copy in order to keep the reference to the original data.

Parameters:

orig

Definition at line 99 of file carray.hpp.

template<class T>

template<std::size_t N>

RTT::types::carray< T >::carray

(

boost::array< T, N > &

orig

)

[inline]

We are constructible from boost::array<T,N> Makes a shallow copy in order to keep the reference to the original data.

Parameters:

orig

Definition at line 112 of file carray.hpp.

---

Member Function Documentation

template<class T>

value_type* RTT::types::carray< T >::address

(

)

const [inline]

The address of the first element of the array.

Returns:

null if count() == 0, the address otherwise.

Definition at line 130 of file carray.hpp.

Referenced by RTT::types::carray< T >::operator=().

template<class T>

std::size_t RTT::types::carray< T >::count

(

)

const [inline]

Returns:

The number of elements in the array.

Definition at line 138 of file carray.hpp.

Referenced by RTT::types::carray< T >::operator=().

template<class T>

const carray<T>& RTT::types::carray< T >::operator=

(

const carray< T > &

orig

)

[inline]

Assignment only copies max(this->count(), orig.count()) elements from orig to this object.

If orig.count() is smaller than this->count() the contents of the remaining elements is left unmodified. If it's greater, the excess elements are ignored.

Definition at line 149 of file carray.hpp.

References RTT::types::carray< T >::address(), and RTT::types::carray< T >::count().

---

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

• rtt/types/carray.hpp