cs_Behaviour.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Dec 6, 2019
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <test/cs_TestAccess.h>
#include <time/cs_DayOfWeek.h>
#include <time/cs_Time.h>
#include <time/cs_TimeOfDay.h>
 
#include <vector>
 
class Behaviour {
public:
    enum class Type : uint8_t { Switch = 0, Twilight = 1, Extended = 2, Undefined = 0xff };
    typedef std::array<uint8_t, 1 + 13> SerializedDataType;
 
protected:
    Type typ;
    uint8_t activeIntensity = 0;
    uint8_t profileId       = 0;
    DayOfWeekBitMask activeDays;
    TimeOfDay behaviourAppliesFrom  = TimeOfDay::Midnight();
    TimeOfDay behaviourAppliesUntil = TimeOfDay::Midnight();
 
public:
    virtual ~Behaviour() = default;  // (to prevent object slicing from leaking memory.)
 
    Behaviour(
            Type typ,
            uint8_t intensity,
            uint8_t profileid,
            DayOfWeekBitMask activedaysofweek,
            TimeOfDay from,
            TimeOfDay until);
 
    Behaviour(SerializedDataType arr);
    SerializedDataType serialize();
 
    // return value: pointer to next empty val in outbuff.
    virtual uint8_t* serialize(uint8_t* outbuff, size_t max_size);
 
    virtual size_t serializedSize() const;
    std::vector<uint8_t> serialized();  // calls the above virtual functions.
 
    virtual void print();
 
    // implementations of behaviours have a class specific identifier
    // which is defined by overriding this method.
    virtual Type getType() const { return Type::Undefined; }
 
    bool isValid(Time currenttime);
 
    virtual bool requiresPresence() { return false; }
    virtual bool requiresAbsence() { return false; }
 
    // =========== Getters ===========
 
    uint8_t value() const;
 
    TimeOfDay from() const;
 
    TimeOfDay until() const;
};