StatusReg.h

00001 /**
00002 * @author Damien Frost
00003 *
00004 * @section LICENSE
00005 *
00006 *   Copyright (c) 2016 Damien Frost
00007 *
00008 *   Permission is hereby granted, free of charge, to any person obtaining a copy
00009 *   of this software and associated documentation files (the "Software"), to deal
00010 *   in the Software without restriction, including without limitation the rights
00011 *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012 *   copies of the Software, and to permit persons to whom the Software is
00013 *   furnished to do so, subject to the following conditions:
00014 *
00015 *   The above copyright notice and this permission notice shall be included in
00016 *   all copies or substantial portions of the Software.
00017 *
00018 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019 *   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020 *   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023 *   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024 *   THE SOFTWARE.
00025 *
00026 * @file "StatusRep.h"
00027 *
00028 * @section DESCRIPTION
00029 *   StatusReg implementation. A register to hold bit-wise status flags.
00030 *
00031 */
00032  
00033 #ifndef STATUSREG_H_
00034 #define STATUSREG_H_
00035 
00036 #include "StatusReg.h"
00037 
00038  /**
00039  * Interface using Wifly to connect to an IP-based network
00040  */
00041 class StatusReg{
00042 public:
00043     // Constructor
00044     StatusReg(void);
00045     
00046     // Set a flag:
00047     void SetFlag(unsigned int flag);
00048     
00049     // Clear a flag:
00050     void ClearFlag(unsigned int flag);
00051     
00052     // Check for flag
00053     bool CheckFlag(unsigned int flag);
00054     
00055     // Check for no flags
00056     bool AllClear(void);
00057     
00058     // Get Register
00059     unsigned int GetReg(void);
00060     
00061 private:
00062     unsigned int _reg;
00063 };
00064 
00065 
00066 #endif /* STATUSREG_H_ */