00001 /********************************************************************* 00002 * 00003 * Software License Agreement (BSD License) 00004 * 00005 * Copyright (c) 2012, Robert Bosch LLC. 00006 * All rights reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions 00010 * are met: 00011 * 00012 * * Redistributions of source code must retain the above copyright 00013 * notice, this list of conditions and the following disclaimer. 00014 * * Redistributions in binary form must reproduce the above 00015 * copyright notice, this list of conditions and the following 00016 * disclaimer in the documentation and/or other materials provided 00017 * with the distribution. 00018 * * Neither the name of the Robert Bosch nor the names of its 00019 * contributors may be used to endorse or promote products derived 00020 * from this software without specific prior written permission. 00021 * 00022 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 00023 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 00024 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 00025 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 00026 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 00027 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 00028 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00029 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00030 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00031 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 00032 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00033 * POSSIBILITY OF SUCH DAMAGE. 00034 * 00035 *********************************************************************/ 00036 00037 //\Author Joshua Vasquez and Philip Roan, Robert Bosch LLC 00038 00039 #ifndef BOSCH_DRIVERS_PARAMETERS_H_ 00040 #define BOSCH_DRIVERS_PARAMETERS_H_ 00041 00042 #include <bosch_drivers_common.hpp> 00043 00044 namespace bosch_drivers_common 00045 { 00051 class Parameters 00052 { 00053 public: 00054 Parameters() {}; 00055 virtual ~Parameters() {}; 00056 00062 interface_protocol protocol_; 00063 00067 int frequency_; 00068 00074 int pin_; 00075 00082 int flags_; 00083 00087 virtual bool setFrequency( int frequency ) = 0; 00088 00092 virtual int getFrequency() = 0; 00093 00099 virtual bool setProtocol( interface_protocol protocol_name ) = 0; 00100 00104 virtual interface_protocol getProtocol() = 0; 00105 00109 virtual int* getFlags() = 0; // SPI only 00110 00116 virtual bool setPin( uint8_t pin ) = 0; // SPI, GPIO only. In read/write methods, the pin is the input to the device_address. 00117 00123 virtual int getPin() = 0; // SPI, GPIO only 00124 }; 00125 } 00126 #endif //BOSCH_DRIVERS_PARAMETERS_H_