smpl_msg_connection.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 SIMPLE_MESSAGE_CONNECTION_H
00033 #define SIMPLE_MESSAGE_CONNECTION_H
00034 
00035 #ifndef FLATHEADERS
00036 #include "simple_message/byte_array.h"
00037 #include "simple_message/simple_message.h"
00038 #include "simple_message/shared_types.h"
00039 #else
00040 #include "byte_array.h"
00041 #include "simple_message.h"
00042 #include "shared_types.h"
00043 #endif
00044 
00045 
00046 namespace industrial
00047 {
00048 namespace smpl_msg_connection
00049 {
00050 
00061 class SmplMsgConnection
00062 
00063 {
00064 public:
00065 
00066   // Message
00067   
00075   virtual bool sendMsg(industrial::simple_message::SimpleMessage & message);
00076   
00084   virtual bool receiveMsg(industrial::simple_message::SimpleMessage & message);
00085   
00096   bool sendAndReceiveMsg(industrial::simple_message::SimpleMessage & send,
00097                          industrial::simple_message::SimpleMessage & recv, 
00098                          bool verbose = false);
00099 
00105   virtual bool isConnected()=0;
00106 
00112   virtual bool makeConnect()=0;
00113 
00114 private:
00115 
00116   // Overrides
00125   virtual bool sendBytes(industrial::byte_array::ByteArray & buffer) =0;
00126   
00136   virtual bool receiveBytes(industrial::byte_array::ByteArray & buffer,
00137                             industrial::shared_types::shared_int num_bytes) =0;
00138 
00139 };
00140 
00141 } //namespace message_connection
00142 } //namespace industrial
00143 
00144 #endif //SIMPLE_MESSAGE_CONNECTION_H


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