Public Member Functions | Static Public Member Functions | Private Attributes
ros::Header Class Reference

Provides functionality to parse a connection header and retrieve values from it. More...

#include <header.h>

List of all members.

Public Member Functions

bool getValue (const std::string &key, std::string &value) const
 Get a value from a parsed header.
M_stringPtr getValues ()
 Returns a shared pointer to the internal map used.
 Header ()
bool parse (const boost::shared_array< uint8_t > &buffer, uint32_t size, std::string &error_msg)
 Parse a header out of a buffer of data.
bool parse (uint8_t *buffer, uint32_t size, std::string &error_msg)
 Parse a header out of a buffer of data.
 ~Header ()

Static Public Member Functions

static void write (const M_string &key_vals, boost::shared_array< uint8_t > &buffer, uint32_t &size)

Private Attributes

M_stringPtr read_map_

Detailed Description

Provides functionality to parse a connection header and retrieve values from it.

Definition at line 58 of file header.h.


Constructor & Destructor Documentation

Definition at line 55 of file header.cpp.

Definition at line 61 of file header.cpp.


Member Function Documentation

bool ros::Header::getValue ( const std::string &  key,
std::string &  value 
) const

Get a value from a parsed header.

Parameters:
keyKey value
valueOUT -- value corresponding to the key if there is one
Returns:
Returns true if the header had the specified key in it

Definition at line 109 of file header.cpp.

M_stringPtr ros::Header::getValues ( ) [inline]

Returns a shared pointer to the internal map used.

Definition at line 74 of file header.h.

bool ros::Header::parse ( const boost::shared_array< uint8_t > &  buffer,
uint32_t  size,
std::string &  error_msg 
)

Parse a header out of a buffer of data.

Definition at line 66 of file header.cpp.

bool ros::Header::parse ( uint8_t *  buffer,
uint32_t  size,
std::string &  error_msg 
)

Parse a header out of a buffer of data.

Definition at line 71 of file header.cpp.

void ros::Header::write ( const M_string &  key_vals,
boost::shared_array< uint8_t > &  buffer,
uint32_t &  size 
) [static]

Definition at line 122 of file header.cpp.


Member Data Documentation

M_stringPtr ros::Header::read_map_ [private]

Definition at line 90 of file header.h.


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


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Mon Oct 6 2014 11:46:44