SelectRom.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 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 MaximInterfaceCore_SelectRom_hpp
00034 #define MaximInterfaceCore_SelectRom_hpp
00035 
00036 #include "Config.hpp"
00037 #include "Function.hpp"
00038 #include "RomCommands.hpp"
00039 #include "RomId.hpp"
00040 
00041 namespace MaximInterfaceCore {
00042 
00043 class OneWireMaster;
00044 
00045 /// Selects a 1-Wire device on the bus for communication.
00046 typedef Function<Result<void>(OneWireMaster &)> SelectRom;
00047 
00048 /// Selector for a multidrop 1-Wire bus.
00049 class SelectMatchRom {
00050 public:
00051   typedef SelectRom::argument_type argument_type;
00052   typedef SelectRom::result_type result_type;
00053 
00054   explicit SelectMatchRom(RomId::const_span romId);
00055 
00056   MaximInterfaceCore_EXPORT Result<void>
00057   operator()(OneWireMaster & master) const;
00058 
00059 private:
00060   RomId::array romId_;
00061 };
00062 
00063 } // namespace MaximInterfaceCore
00064 
00065 #endif