rosrecord: constants.h Source File

00001 /*********************************************************************
00002 * Software License Agreement (BSD License)
00003 *
00004 *  Copyright (c) 2008, Willow Garage, Inc.
00005 *  All rights reserved.
00006 *
00007 *  Redistribution and use in source and binary forms, with or without
00008 *  modification, are permitted provided that the following conditions
00009 *  are met:
00010 *
00011 *   * Redistributions of source code must retain the above copyright
00012 *     notice, this list of conditions and the following disclaimer.
00013 *   * Redistributions in binary form must reproduce the above
00014 *     copyright notice, this list of conditions and the following
00015 *     disclaimer in the documentation and/or other materials provided
00016 *     with the distribution.
00017 *   * Neither the name of Willow Garage, Inc. nor the names of its
00018 *     contributors may be used to endorse or promote products derived
00019 *     from this software without specific prior written permission.
00020 *
00021 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032 *  POSSIBILITY OF SUCH DAMAGE.
00033 *********************************************************************/
00034 
00035 #ifndef ROSRECORD_CONSTANTS_H
00036 #define ROSRECORD_CONSTANTS_H
00037 
00038 #include <string>
00039 #include <stdint.h>
00040 
00041 namespace ros
00042 {
00043 namespace record
00044 {
00045 
00046 // Log file version to write
00047 static const std::string VERSION = "1.2";
00048 
00049 // Bytes reserved for file header record (4KB)
00050 static const uint32_t FILE_HEADER_LENGTH = 4 * 1024;
00051 
00052 // Header field delimiter
00053 static const unsigned char FIELD_DELIM = '=';
00054 
00055 // Header field keys
00056 static const std::string OP_FIELD_NAME        = "op";
00057 static const std::string TOPIC_FIELD_NAME     = "topic";
00058 static const std::string MD5_FIELD_NAME       = "md5";
00059 static const std::string SEC_FIELD_NAME       = "sec";
00060 static const std::string NSEC_FIELD_NAME      = "nsec";
00061 static const std::string TYPE_FIELD_NAME      = "type";
00062 static const std::string DEF_FIELD_NAME       = "def";
00063 static const std::string LATCHING_FIELD_NAME  = "latching";
00064 static const std::string CALLERID_FIELD_NAME  = "callerid";
00065 static const std::string VER_FIELD_NAME       = "ver";
00066 static const std::string COUNT_FIELD_NAME     = "count";
00067 static const std::string INDEX_POS_FIELD_NAME = "index_pos";
00068 
00069 // Index data record version to write
00070 static const uint32_t INDEX_VERSION = 0;
00071 
00072 // The valid values of the "op" field
00073 static const unsigned char OP_MSG_DEF     = 0x01;
00074 static const unsigned char OP_MSG_DATA    = 0x02;
00075 static const unsigned char OP_FILE_HEADER = 0x03;
00076 static const unsigned char OP_INDEX_DATA  = 0x04;
00077 
00078 }
00079 }
00080 
00081 #endif