AaronCameron.net
I care not for your petty politics.
Not a Member? - Login or Create an Account
Tuesday the 22nd of May 2012 @ 01:50am
Front Page Journal Projects Your Profile About
[]

LibN2L


Documentation
(n2l5)


Documentation
(libN2L-4)


Bugtracker


Related Things

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

timing

cOscillator.h

Go to the documentation of this file.
00001 /************************************************************************
00002 Nova-2 Library (libN2L, or simply n2l) Game development C++ Library
00003 Copyright (C) 2002  Aaron Cameron
00004 
00005 This library is free software; you can redistribute it and/or
00006 modify it under the terms of the GNU Lesser General Public
00007 License as published by the Free Software Foundation; either
00008 version 2.1 of the License, or (at your option) any later version.
00009 
00010 This library is distributed in the hope that it will be useful,
00011 but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013 Lesser General Public License for more details.
00014 
00015 You should have received a copy of the GNU Lesser General Public
00016 License along with this library; if not, write to the Free Software
00017 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00018 
00019 A copy of the GNU Lesser General Public License has been provided with
00020 this library in the file 'COPYING'.
00021 
00022 Contact information for the author of this library has been provided
00023 with this library in the file 'AUTHOR'.
00024 ************************************************************************/
00025 #ifndef _n2l4_cOscillator_H
00026 #define _n2l4_cOscillator_H
00027 
00028 #include "n2l/n2l.h"
00029 #include "types.h"
00030 
00031 namespace n2l
00032 {
00036     class cOscillator
00037     {
00038     public:
00039         enum tOverrunBehaviour
00040         {
00041             OverrunBehaviour_Skip =     0,
00042             OverrunBehaviour_CatchUp =  1
00043         };
00044 
00045         enum tAutoTrigger {
00046             AutoTrigger_TriggerOnRequest = 0,
00047             AutoTrigger_ExplicitTriggerOnly = 1
00048         };
00049 
00050         static const tHertz DefaultFrequency;
00051 
00055         class cOverdueException : public cException
00056         {
00057         public:
00058             cOverdueException() :
00059                 cException("cOscillator","Overdue cycle","Overdue Cycle Warning") {}
00060 
00061             virtual void rethrow() const { throw *this; }
00062         };
00063 
00064     private:
00065         tUint m_nextCycle;
00066         tHertz m_frequency;
00067         tOverrunBehaviour m_overrunBehaviour;
00068         tBool m_warnOnOverrun;
00069         tBool m_autoTrigger;
00070 
00071         tUint m_timeStep;
00072 
00073         const tUint getTimeStepForFreq( const tHertz i_freq ) const;
00074 
00075     public:
00076         cOscillator();
00077         cOscillator(const tHertz i_frequency,
00078                     const tOverrunBehaviour i_ob = OverrunBehaviour_Skip );
00079         virtual ~cOscillator();
00080 
00081         const tBool isTime();
00082 
00083 
00091         void wait();
00092 
00093 
00098         const tSint timeLeft() const;
00099 
00100         void setFrequency( const tHertz i_frequency );
00101         void setOverrunBehaviour( const tOverrunBehaviour i_ob );
00102         void setOverrunWarningFlag( const tBool i_flag );
00103         void setAutoTrigger( const tAutoTrigger i_autoTrigger );
00104 
00105 
00116         void sync();
00117 
00121         void triggered();
00122         
00123      }; // class cOscillator
00124 
00125 } // namespace n2l
00126 
00127 #endif
©2012 Aaron Cameron