Diff: microbit/microbit-dal/inc/drivers/TimedInterruptIn.h

Revision:

0:b9164b348919

diff -r 000000000000 -r b9164b348919 microbit/microbit-dal/inc/drivers/TimedInterruptIn.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/microbit/microbit-dal/inc/drivers/TimedInterruptIn.h	Mon Oct 17 12:41:20 2016 +0000
@@ -0,0 +1,59 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2016 Lancaster University, UK.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+*/
+
+#ifndef TIMED_INTERRUPT_H
+#define TIMED_INTERRUPT_H
+
+#include "mbed.h"
+#include "MicroBitConfig.h"
+
+class TimedInterruptIn : public InterruptIn
+{
+    uint64_t timestamp;
+
+    public:
+
+    /**
+      * Constructor.
+      *
+      * Create an instance of TimedInterruptIn that has an additional timestamp field.
+      */
+    TimedInterruptIn(PinName name);
+
+    /**
+      * Stores the given timestamp for this instance of TimedInterruptIn.
+      *
+      * @param timestamp the timestamp to retain.
+      */
+    void setTimestamp(uint64_t timestamp);
+
+    /**
+      * Retrieves the retained timestamp for this instance of TimedInterruptIn.
+      *
+      * @return the timestamp held by this instance.
+      */
+    uint64_t getTimestamp();
+};
+
+#endif
\ No newline at end of file