byte_array.h
Go to the documentation of this file.
00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  * Copyright (c) 2011, Southwest Research Institute
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 are met:
00009  *
00010  *       * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *       * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *       * Neither the name of the Southwest Research Institute, nor the names
00016  *       of its contributors may be used to endorse or promote products derived
00017  *       from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029  * POSSIBILITY OF SUCH DAMAGE.
00030  */
00031 
00032 #ifndef BYTE_ARRAY_H
00033 #define BYTE_ARRAY_H
00034 
00035 #ifndef FLATHEADERS
00036 #include "simple_message/shared_types.h"
00037 #else
00038 #include "shared_types.h"
00039 #endif
00040 
00041 #include "string.h"
00042 
00043 namespace industrial
00044 {
00045 namespace simple_serialize
00046 {
00047 // Class declaration required for function prototypes below
00048 class SimpleSerialize;
00049 }
00050 }
00051 
00052 namespace industrial
00053 {
00054 namespace byte_array
00055 {
00056 
00077 class ByteArray
00078 {
00079 public:
00080 
00081   // Provides SimpleSerialize access to byte array internals
00082   friend class SimpleSerialize;
00083 
00090   ByteArray(void);
00091 
00096   ~ByteArray(void);
00097 
00104   void init();
00105 
00119   bool init(const char* buffer, const industrial::shared_types::shared_int byte_size);
00120 
00130   void copyFrom(ByteArray & buffer);
00131 
00140   bool load(industrial::shared_types::shared_bool value);
00141 
00152   bool load(industrial::shared_types::shared_real value);
00153 
00163   bool load(industrial::shared_types::shared_int value);
00164 
00173   bool load(industrial::simple_serialize::SimpleSerialize &value);
00174 
00183   bool load(ByteArray &value);
00184 
00195   bool load(void* value, const industrial::shared_types::shared_int byte_size);
00196 
00204   bool unload(industrial::shared_types::shared_bool &value);
00205 
00214   bool unload(industrial::shared_types::shared_real &value);
00215 
00224   bool unload(industrial::shared_types::shared_int &value);
00225 
00233   bool unload(industrial::simple_serialize::SimpleSerialize &value);
00234 
00244   bool unload(ByteArray &value, const industrial::shared_types::shared_int byte_size);
00245 
00255   bool unload(void* value, const industrial::shared_types::shared_int byteSize);
00256 
00267   bool unloadFront(industrial::shared_types::shared_real &value);
00268 
00279   bool unloadFront(industrial::shared_types::shared_int &value);
00280 
00292   bool unloadFront(void* value, const industrial::shared_types::shared_int byteSize);
00293 
00306   char* getRawDataPtr();
00307 
00313   unsigned int getBufferSize();
00314 
00320   unsigned int getMaxBufferSize();
00321 
00329   static bool isByteSwapEnabled();
00330 
00331 private:
00340   static const industrial::shared_types::shared_int MAX_SIZE = 1024;
00341 
00345   char buffer_[MAX_SIZE];
00346 
00350   industrial::shared_types::shared_int buffer_size_;
00351 
00352 #ifdef BYTE_SWAPPING
00353 
00360   void swap(void *value, industrial::shared_types::shared_int byteSize);
00361 #endif
00362 
00370   bool setBufferSize(const industrial::shared_types::shared_int size);
00371 
00379   bool extendBufferSize(const industrial::shared_types::shared_int size);
00380 
00388   bool shortenBufferSize(industrial::shared_types::shared_int size);
00389 
00397   char* getLoadPtr();
00398 
00407   char* getUnloadPtr(const industrial::shared_types::shared_int num_bytes);
00408 
00409 };
00410 
00411 } // namespace industrial
00412 } // namespace byte_array
00413 
00414 #endif //BYTE_ARRAY_H


simple_message
Author(s): Shaun Edwards
autogenerated on Fri Aug 28 2015 11:11:56