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 (uint8_t *buffer, uint32_t size, std::string &error_msg)
 Parse a header out of a buffer of data.
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.
 ~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 57 of file header.h.


Constructor & Destructor Documentation

ros::Header::Header (  ) 

Definition at line 51 of file header.cpp.

ros::Header::~Header (  ) 

Definition at line 57 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:
key Key value
value OUT -- value corresponding to the key if there is one
Returns:
Returns true if the header had the specified key in it

Definition at line 105 of file header.cpp.

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

Returns a shared pointer to the internal map used.

Definition at line 73 of file header.h.

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 67 of file header.cpp.

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 62 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 118 of file header.cpp.


Member Data Documentation

Definition at line 89 of file header.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


roscpp
Author(s): Morgan Quigley mquigley@cs.stanford.edu, Josh Faust jfaust@willowgarage.com, Brian Gerkey gerkey@willowgarage.com
autogenerated on Fri Jan 11 10:08:40 2013