byte_array.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 * Copyright (c) 2015, Southwest Research Institute
 * All rights reserved.
 *
 * 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 name of the Southwest Research Institute, 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 BYTE_ARRAY_H
#define BYTE_ARRAY_H

#ifndef FLATHEADERS
#include "simple_message/shared_types.h"
#else
#include "shared_types.h"
#endif

#include <deque>
#include <vector>
#include "string.h"

namespace industrial
{
namespace simple_serialize
{
// Class declaration required for function prototypes below
class SimpleSerialize;
}
}

namespace industrial
{
namespace byte_array
{

class ByteArray
{
public:

  // Provides SimpleSerialize access to byte array internals
  friend class SimpleSerialize;

  ByteArray(void);

  ~ByteArray(void);

  void init();

  bool init(const char* buffer, const industrial::shared_types::shared_int byte_size);

  void copyFrom(ByteArray & buffer);

  void copyTo(std::vector<char> & out);

  bool load(industrial::shared_types::shared_bool value);

  bool load(industrial::shared_types::shared_real value);

  bool load(industrial::shared_types::shared_int value);

  bool load(industrial::simple_serialize::SimpleSerialize &value);

  bool load(ByteArray &value);

  bool load(void* value, const industrial::shared_types::shared_int byte_size);

  bool unload(industrial::shared_types::shared_bool &value);

  bool unload(industrial::shared_types::shared_real &value);

  bool unload(industrial::shared_types::shared_int &value);

  bool unload(industrial::simple_serialize::SimpleSerialize &value);

  bool unload(ByteArray &value, const industrial::shared_types::shared_int byte_size);

  bool unload(void* value, const industrial::shared_types::shared_int byteSize);

  bool unloadFront(industrial::shared_types::shared_real &value);

  bool unloadFront(industrial::shared_types::shared_int &value);

  bool unloadFront(void* value, const industrial::shared_types::shared_int byteSize);

   __attribute__((deprecated("This ptr will be invalid once buffer is changed.  Please use: copyTo(vector<char>) instead.")))
  char* getRawDataPtr();

  unsigned int getBufferSize();

  unsigned int getMaxBufferSize();

  static bool isByteSwapEnabled();

private:

  std::deque<char> buffer_;
  
   std::vector<char> getRawDataPtr_buffer_;

#ifdef BYTE_SWAPPING

  void swap(void *value, industrial::shared_types::shared_int byteSize);
#endif

};

} // namespace industrial
} // namespace byte_array

#endif //BYTE_ARRAY_H