/usr/include/ros/serialization.h is in libroscpp-core-dev 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 | /*
* Copyright (C) 2009, Willow Garage, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the names of Willow Garage, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ROSCPP_SERIALIZATION_H
#define ROSCPP_SERIALIZATION_H
#include "roscpp_serialization_macros.h"
#include <ros/types.h>
#include <ros/time.h>
#include "serialized_message.h"
#include "ros/message_traits.h"
#include "ros/builtin_message_traits.h"
#include "ros/exception.h"
#include "ros/datatypes.h"
#include <vector>
#include <map>
#include <boost/array.hpp>
#include <boost/call_traits.hpp>
#include <boost/utility/enable_if.hpp>
#include <boost/mpl/and.hpp>
#include <boost/mpl/or.hpp>
#include <boost/mpl/not.hpp>
#include <cstring>
#define ROS_NEW_SERIALIZATION_API 1
/**
* \brief Declare your serializer to use an allInOne member instead of requiring 3 different serialization
* functions.
*
* The allinone method has the form:
\verbatim
template<typename Stream, typename T>
inline static void allInOne(Stream& stream, T t)
{
stream.next(t.a);
stream.next(t.b);
...
}
\endverbatim
*
* The only guarantee given is that Stream::next(T) is defined.
*/
#define ROS_DECLARE_ALLINONE_SERIALIZER \
template<typename Stream, typename T> \
inline static void write(Stream& stream, const T& t) \
{ \
allInOne<Stream, const T&>(stream, t); \
} \
\
template<typename Stream, typename T> \
inline static void read(Stream& stream, T& t) \
{ \
allInOne<Stream, T&>(stream, t); \
} \
\
template<typename T> \
inline static uint32_t serializedLength(const T& t) \
{ \
LStream stream; \
allInOne<LStream, const T&>(stream, t); \
return stream.getLength(); \
}
namespace ros
{
namespace serialization
{
namespace mt = message_traits;
namespace mpl = boost::mpl;
class ROSCPP_SERIALIZATION_DECL StreamOverrunException : public ros::Exception
{
public:
StreamOverrunException(const std::string& what)
: Exception(what)
{}
};
ROSCPP_SERIALIZATION_DECL void throwStreamOverrun();
/**
* \brief Templated serialization class. Default implementation provides backwards compatibility with
* old message types.
*
* Specializing the Serializer class is the only thing you need to do to get the ROS serialization system
* to work with a type.
*/
template<typename T>
struct Serializer
{
/**
* \brief Write an object to the stream. Normally the stream passed in here will be a ros::serialization::OStream
*/
template<typename Stream>
inline static void write(Stream& stream, typename boost::call_traits<T>::param_type t)
{
t.serialize(stream.getData(), 0);
}
/**
* \brief Read an object from the stream. Normally the stream passed in here will be a ros::serialization::IStream
*/
template<typename Stream>
inline static void read(Stream& stream, typename boost::call_traits<T>::reference t)
{
t.deserialize(stream.getData());
}
/**
* \brief Determine the serialized length of an object.
*/
inline static uint32_t serializedLength(typename boost::call_traits<T>::param_type t)
{
return t.serializationLength();
}
};
/**
* \brief Serialize an object. Stream here should normally be a ros::serialization::OStream
*/
template<typename T, typename Stream>
inline void serialize(Stream& stream, const T& t)
{
Serializer<T>::write(stream, t);
}
/**
* \brief Deserialize an object. Stream here should normally be a ros::serialization::IStream
*/
template<typename T, typename Stream>
inline void deserialize(Stream& stream, T& t)
{
Serializer<T>::read(stream, t);
}
/**
* \brief Determine the serialized length of an object
*/
template<typename T>
inline uint32_t serializationLength(const T& t)
{
return Serializer<T>::serializedLength(t);
}
#define ROS_CREATE_SIMPLE_SERIALIZER(Type) \
template<> struct Serializer<Type> \
{ \
template<typename Stream> inline static void write(Stream& stream, const Type v) \
{ \
*reinterpret_cast<Type*>(stream.advance(sizeof(v))) = v; \
} \
\
template<typename Stream> inline static void read(Stream& stream, Type& v) \
{ \
v = *reinterpret_cast<Type*>(stream.advance(sizeof(v))); \
} \
\
inline static uint32_t serializedLength(const Type&) \
{ \
return sizeof(Type); \
} \
};
#define ROS_CREATE_SIMPLE_SERIALIZER_ARM(Type) \
template<> struct Serializer<Type> \
{ \
template<typename Stream> inline static void write(Stream& stream, const Type v) \
{ \
memcpy(stream.advance(sizeof(v)), &v, sizeof(v) ); \
} \
\
template<typename Stream> inline static void read(Stream& stream, Type& v) \
{ \
memcpy(&v, stream.advance(sizeof(v)), sizeof(v) ); \
} \
\
inline static uint32_t serializedLength(const Type&) \
{ \
return sizeof(Type); \
} \
};
#if defined(__arm__) || defined(__arm)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(uint8_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(int8_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(uint16_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(int16_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(uint32_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(int32_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(uint64_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(int64_t)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(float)
ROS_CREATE_SIMPLE_SERIALIZER_ARM(double)
#else
ROS_CREATE_SIMPLE_SERIALIZER(uint8_t)
ROS_CREATE_SIMPLE_SERIALIZER(int8_t)
ROS_CREATE_SIMPLE_SERIALIZER(uint16_t)
ROS_CREATE_SIMPLE_SERIALIZER(int16_t)
ROS_CREATE_SIMPLE_SERIALIZER(uint32_t)
ROS_CREATE_SIMPLE_SERIALIZER(int32_t)
ROS_CREATE_SIMPLE_SERIALIZER(uint64_t)
ROS_CREATE_SIMPLE_SERIALIZER(int64_t)
ROS_CREATE_SIMPLE_SERIALIZER(float)
ROS_CREATE_SIMPLE_SERIALIZER(double)
#endif
/**
* \brief Serializer specialized for bool (serialized as uint8)
*/
template<> struct Serializer<bool>
{
template<typename Stream> inline static void write(Stream& stream, const bool v)
{
uint8_t b = (uint8_t)v;
#if defined(__arm__) || defined(__arm)
memcpy(stream.advance(1), &b, 1 );
#else
*reinterpret_cast<uint8_t*>(stream.advance(1)) = b;
#endif
}
template<typename Stream> inline static void read(Stream& stream, bool& v)
{
uint8_t b;
#if defined(__arm__) || defined(__arm)
memcpy(&b, stream.advance(1), 1 );
#else
b = *reinterpret_cast<uint8_t*>(stream.advance(1));
#endif
v = (bool)b;
}
inline static uint32_t serializedLength(bool)
{
return 1;
}
};
/**
* \brief Serializer specialized for std::string
*/
template<class ContainerAllocator>
struct Serializer<std::basic_string<char, std::char_traits<char>, ContainerAllocator> >
{
typedef std::basic_string<char, std::char_traits<char>, ContainerAllocator> StringType;
template<typename Stream>
inline static void write(Stream& stream, const StringType& str)
{
size_t len = str.size();
stream.next((uint32_t)len);
if (len > 0)
{
memcpy(stream.advance((uint32_t)len), str.data(), len);
}
}
template<typename Stream>
inline static void read(Stream& stream, StringType& str)
{
uint32_t len;
stream.next(len);
if (len > 0)
{
str = StringType((char*)stream.advance(len), len);
}
else
{
str.clear();
}
}
inline static uint32_t serializedLength(const StringType& str)
{
return 4 + (uint32_t)str.size();
}
};
/**
* \brief Serializer specialized for ros::Time
*/
template<>
struct Serializer<ros::Time>
{
template<typename Stream>
inline static void write(Stream& stream, const ros::Time& v)
{
stream.next(v.sec);
stream.next(v.nsec);
}
template<typename Stream>
inline static void read(Stream& stream, ros::Time& v)
{
stream.next(v.sec);
stream.next(v.nsec);
}
inline static uint32_t serializedLength(const ros::Time&)
{
return 8;
}
};
/**
* \brief Serializer specialized for ros::Duration
*/
template<>
struct Serializer<ros::Duration>
{
template<typename Stream>
inline static void write(Stream& stream, const ros::Duration& v)
{
stream.next(v.sec);
stream.next(v.nsec);
}
template<typename Stream>
inline static void read(Stream& stream, ros::Duration& v)
{
stream.next(v.sec);
stream.next(v.nsec);
}
inline static uint32_t serializedLength(const ros::Duration&)
{
return 8;
}
};
/**
* \brief Vector serializer. Default implementation does nothing
*/
template<typename T, class ContainerAllocator, class Enabled = void>
struct VectorSerializer
{};
/**
* \brief Vector serializer, specialized for non-fixed-size, non-simple types
*/
template<typename T, class ContainerAllocator>
struct VectorSerializer<T, ContainerAllocator, typename boost::disable_if<mt::IsFixedSize<T> >::type >
{
typedef std::vector<T, typename ContainerAllocator::template rebind<T>::other> VecType;
typedef typename VecType::iterator IteratorType;
typedef typename VecType::const_iterator ConstIteratorType;
template<typename Stream>
inline static void write(Stream& stream, const VecType& v)
{
stream.next((uint32_t)v.size());
ConstIteratorType it = v.begin();
ConstIteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
template<typename Stream>
inline static void read(Stream& stream, VecType& v)
{
uint32_t len;
stream.next(len);
v.resize(len);
IteratorType it = v.begin();
IteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
inline static uint32_t serializedLength(const VecType& v)
{
uint32_t size = 4;
ConstIteratorType it = v.begin();
ConstIteratorType end = v.end();
for (; it != end; ++it)
{
size += serializationLength(*it);
}
return size;
}
};
/**
* \brief Vector serializer, specialized for fixed-size simple types
*/
template<typename T, class ContainerAllocator>
struct VectorSerializer<T, ContainerAllocator, typename boost::enable_if<mt::IsSimple<T> >::type >
{
typedef std::vector<T, typename ContainerAllocator::template rebind<T>::other> VecType;
typedef typename VecType::iterator IteratorType;
typedef typename VecType::const_iterator ConstIteratorType;
template<typename Stream>
inline static void write(Stream& stream, const VecType& v)
{
uint32_t len = (uint32_t)v.size();
stream.next(len);
if (!v.empty())
{
const uint32_t data_len = len * (uint32_t)sizeof(T);
memcpy(stream.advance(data_len), &v.front(), data_len);
}
}
template<typename Stream>
inline static void read(Stream& stream, VecType& v)
{
uint32_t len;
stream.next(len);
v.resize(len);
if (len > 0)
{
const uint32_t data_len = (uint32_t)sizeof(T) * len;
memcpy(&v.front(), stream.advance(data_len), data_len);
}
}
inline static uint32_t serializedLength(const VecType& v)
{
return 4 + v.size() * (uint32_t)sizeof(T);
}
};
/**
* \brief Vector serializer, specialized for fixed-size non-simple types
*/
template<typename T, class ContainerAllocator>
struct VectorSerializer<T, ContainerAllocator, typename boost::enable_if<mpl::and_<mt::IsFixedSize<T>, mpl::not_<mt::IsSimple<T> > > >::type >
{
typedef std::vector<T, typename ContainerAllocator::template rebind<T>::other> VecType;
typedef typename VecType::iterator IteratorType;
typedef typename VecType::const_iterator ConstIteratorType;
template<typename Stream>
inline static void write(Stream& stream, const VecType& v)
{
stream.next((uint32_t)v.size());
ConstIteratorType it = v.begin();
ConstIteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
template<typename Stream>
inline static void read(Stream& stream, VecType& v)
{
uint32_t len;
stream.next(len);
v.resize(len);
IteratorType it = v.begin();
IteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
inline static uint32_t serializedLength(const VecType& v)
{
uint32_t size = 4;
if (!v.empty())
{
uint32_t len_each = serializationLength(v.front());
size += len_each * (uint32_t)v.size();
}
return size;
}
};
/**
* \brief serialize version for std::vector
*/
template<typename T, class ContainerAllocator, typename Stream>
inline void serialize(Stream& stream, const std::vector<T, ContainerAllocator>& t)
{
VectorSerializer<T, ContainerAllocator>::write(stream, t);
}
/**
* \brief deserialize version for std::vector
*/
template<typename T, class ContainerAllocator, typename Stream>
inline void deserialize(Stream& stream, std::vector<T, ContainerAllocator>& t)
{
VectorSerializer<T, ContainerAllocator>::read(stream, t);
}
/**
* \brief serializationLength version for std::vector
*/
template<typename T, class ContainerAllocator>
inline uint32_t serializationLength(const std::vector<T, ContainerAllocator>& t)
{
return VectorSerializer<T, ContainerAllocator>::serializedLength(t);
}
/**
* \brief Array serializer, default implementation does nothing
*/
template<typename T, size_t N, class Enabled = void>
struct ArraySerializer
{};
/**
* \brief Array serializer, specialized for non-fixed-size, non-simple types
*/
template<typename T, size_t N>
struct ArraySerializer<T, N, typename boost::disable_if<mt::IsFixedSize<T> >::type>
{
typedef boost::array<T, N > ArrayType;
typedef typename ArrayType::iterator IteratorType;
typedef typename ArrayType::const_iterator ConstIteratorType;
template<typename Stream>
inline static void write(Stream& stream, const ArrayType& v)
{
ConstIteratorType it = v.begin();
ConstIteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
template<typename Stream>
inline static void read(Stream& stream, ArrayType& v)
{
IteratorType it = v.begin();
IteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
inline static uint32_t serializedLength(const ArrayType& v)
{
uint32_t size = 0;
ConstIteratorType it = v.begin();
ConstIteratorType end = v.end();
for (; it != end; ++it)
{
size += serializationLength(*it);
}
return size;
}
};
/**
* \brief Array serializer, specialized for fixed-size, simple types
*/
template<typename T, size_t N>
struct ArraySerializer<T, N, typename boost::enable_if<mt::IsSimple<T> >::type>
{
typedef boost::array<T, N > ArrayType;
typedef typename ArrayType::iterator IteratorType;
typedef typename ArrayType::const_iterator ConstIteratorType;
template<typename Stream>
inline static void write(Stream& stream, const ArrayType& v)
{
const uint32_t data_len = N * sizeof(T);
memcpy(stream.advance(data_len), &v.front(), data_len);
}
template<typename Stream>
inline static void read(Stream& stream, ArrayType& v)
{
const uint32_t data_len = N * sizeof(T);
memcpy(&v.front(), stream.advance(data_len), data_len);
}
inline static uint32_t serializedLength(const ArrayType&)
{
return N * sizeof(T);
}
};
/**
* \brief Array serializer, specialized for fixed-size, non-simple types
*/
template<typename T, size_t N>
struct ArraySerializer<T, N, typename boost::enable_if<mpl::and_<mt::IsFixedSize<T>, mpl::not_<mt::IsSimple<T> > > >::type>
{
typedef boost::array<T, N > ArrayType;
typedef typename ArrayType::iterator IteratorType;
typedef typename ArrayType::const_iterator ConstIteratorType;
template<typename Stream>
inline static void write(Stream& stream, const ArrayType& v)
{
ConstIteratorType it = v.begin();
ConstIteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
template<typename Stream>
inline static void read(Stream& stream, ArrayType& v)
{
IteratorType it = v.begin();
IteratorType end = v.end();
for (; it != end; ++it)
{
stream.next(*it);
}
}
inline static uint32_t serializedLength(const ArrayType& v)
{
return serializationLength(v.front()) * N;
}
};
/**
* \brief serialize version for boost::array
*/
template<typename T, size_t N, typename Stream>
inline void serialize(Stream& stream, const boost::array<T, N>& t)
{
ArraySerializer<T, N>::write(stream, t);
}
/**
* \brief deserialize version for boost::array
*/
template<typename T, size_t N, typename Stream>
inline void deserialize(Stream& stream, boost::array<T, N>& t)
{
ArraySerializer<T, N>::read(stream, t);
}
/**
* \brief serializationLength version for boost::array
*/
template<typename T, size_t N>
inline uint32_t serializationLength(const boost::array<T, N>& t)
{
return ArraySerializer<T, N>::serializedLength(t);
}
/**
* \brief Enum
*/
namespace stream_types
{
enum StreamType
{
Input,
Output,
Length
};
}
typedef stream_types::StreamType StreamType;
/**
* \brief Stream base-class, provides common functionality for IStream and OStream
*/
struct ROSCPP_SERIALIZATION_DECL Stream
{
/*
* \brief Returns a pointer to the current position of the stream
*/
inline uint8_t* getData() { return data_; }
/**
* \brief Advances the stream, checking bounds, and returns a pointer to the position before it
* was advanced.
* \throws StreamOverrunException if len would take this stream past the end of its buffer
*/
ROS_FORCE_INLINE uint8_t* advance(uint32_t len)
{
uint8_t* old_data = data_;
data_ += len;
if (data_ > end_)
{
// Throwing directly here causes a significant speed hit due to the extra code generated
// for the throw statement
throwStreamOverrun();
}
return old_data;
}
/**
* \brief Returns the amount of space left in the stream
*/
inline uint32_t getLength() { return (uint32_t)(end_ - data_); }
protected:
Stream(uint8_t* _data, uint32_t _count)
: data_(_data)
, end_(_data + _count)
{}
private:
uint8_t* data_;
uint8_t* end_;
};
/**
* \brief Input stream
*/
struct ROSCPP_SERIALIZATION_DECL IStream : public Stream
{
static const StreamType stream_type = stream_types::Input;
IStream(uint8_t* data, uint32_t count)
: Stream(data, count)
{}
/**
* \brief Deserialize an item from this input stream
*/
template<typename T>
ROS_FORCE_INLINE void next(T& t)
{
deserialize(*this, t);
}
template<typename T>
ROS_FORCE_INLINE IStream& operator>>(T& t)
{
deserialize(*this, t);
return *this;
}
};
/**
* \brief Output stream
*/
struct ROSCPP_SERIALIZATION_DECL OStream : public Stream
{
static const StreamType stream_type = stream_types::Output;
OStream(uint8_t* data, uint32_t count)
: Stream(data, count)
{}
/**
* \brief Serialize an item to this output stream
*/
template<typename T>
ROS_FORCE_INLINE void next(const T& t)
{
serialize(*this, t);
}
template<typename T>
ROS_FORCE_INLINE OStream& operator<<(const T& t)
{
serialize(*this, t);
return *this;
}
};
/**
* \brief Length stream
*
* LStream is not what you would normally think of as a stream, but it is used in order to support
* allinone serializers.
*/
struct ROSCPP_SERIALIZATION_DECL LStream
{
static const StreamType stream_type = stream_types::Length;
LStream()
: count_(0)
{}
/**
* \brief Add the length of an item to this length stream
*/
template<typename T>
ROS_FORCE_INLINE void next(const T& t)
{
count_ += serializationLength(t);
}
/**
* \brief increment the length by len
*/
ROS_FORCE_INLINE uint32_t advance(uint32_t len)
{
uint32_t old = count_;
count_ += len;
return old;
}
/**
* \brief Get the total length of this tream
*/
inline uint32_t getLength() { return count_; }
private:
uint32_t count_;
};
/**
* \brief Serialize a message
*/
template<typename M>
inline SerializedMessage serializeMessage(const M& message)
{
SerializedMessage m;
uint32_t len = serializationLength(message);
m.num_bytes = len + 4;
m.buf.reset(new uint8_t[m.num_bytes]);
OStream s(m.buf.get(), (uint32_t)m.num_bytes);
serialize(s, (uint32_t)m.num_bytes - 4);
m.message_start = s.getData();
serialize(s, message);
return m;
}
/**
* \brief Serialize a service response
*/
template<typename M>
inline SerializedMessage serializeServiceResponse(bool ok, const M& message)
{
SerializedMessage m;
if (ok)
{
uint32_t len = serializationLength(message);
m.num_bytes = len + 5;
m.buf.reset(new uint8_t[m.num_bytes]);
OStream s(m.buf.get(), (uint32_t)m.num_bytes);
serialize(s, (uint8_t)ok);
serialize(s, (uint32_t)m.num_bytes - 5);
serialize(s, message);
}
else
{
uint32_t len = serializationLength(message);
m.num_bytes = len + 1;
m.buf.reset(new uint8_t[m.num_bytes]);
OStream s(m.buf.get(), (uint32_t)m.num_bytes);
serialize(s, (uint8_t)ok);
serialize(s, message);
}
return m;
}
/**
* \brief Deserialize a message. If includes_length is true, skips the first 4 bytes
*/
template<typename M>
inline void deserializeMessage(const SerializedMessage& m, M& message)
{
IStream s(m.message_start, m.num_bytes - (m.message_start - m.buf.get()));
deserialize(s, message);
}
// Additional serialization traits
template<typename M>
struct PreDeserializeParams
{
boost::shared_ptr<M> message;
boost::shared_ptr<std::map<std::string, std::string> > connection_header;
};
/**
* \brief called by the SubscriptionCallbackHelper after a message is
* instantiated but before that message is deserialized
*/
template<typename M>
struct PreDeserialize
{
static void notify(const PreDeserializeParams<M>&) { }
};
} // namespace serialization
} // namespace ros
#endif // ROSCPP_SERIALIZATION_H
|