LoggingOneWireMaster.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterface_LoggingOneWireMaster
00034 #define MaximInterface_LoggingOneWireMaster
00035 
00036 #include <string>
00037 #include <MaximInterface/Links/OneWireMasterDecorator.hpp>
00038 #include <MaximInterface/Utilities/Export.h>
00039 #include <MaximInterface/Utilities/WriteMessage.hpp>
00040 
00041 namespace MaximInterface {
00042 
00043 class LoggingOneWireMaster : public OneWireMasterDecorator {
00044 public:
00045   explicit LoggingOneWireMaster(
00046       OneWireMaster & master,
00047       const WriteMessage & writeMessage = WriteMessage())
00048       : OneWireMasterDecorator(master), writeMessage(writeMessage) {}
00049 
00050   void setWriteMessage(const WriteMessage & writeMessage) {
00051     this->writeMessage = writeMessage;
00052   }
00053 
00054   MaximInterface_EXPORT virtual error_code reset();
00055   
00056   MaximInterface_EXPORT virtual error_code
00057   writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
00058   
00059   MaximInterface_EXPORT virtual error_code
00060   readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
00061   
00062   MaximInterface_EXPORT virtual error_code
00063   writeBlock(span<const uint_least8_t> sendBuf);
00064   
00065   MaximInterface_EXPORT virtual error_code
00066   readBlock(span<uint_least8_t> recvBuf);
00067   
00068   MaximInterface_EXPORT virtual error_code setSpeed(Speed newSpeed);
00069   
00070   MaximInterface_EXPORT virtual error_code setLevel(Level newLevel);
00071 
00072 private:
00073   void tryWriteMessage(const std::string & message);
00074 
00075   WriteMessage writeMessage;
00076 };
00077 
00078 } // namespace MaximInterface
00079 
00080 #endif