Periodic.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2021 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/physical/common/Types.h"
#include "bio/physical/common/Class.h"
#include "bio/common/VirtualBase.h"
 
namespace bio {
namespace physical {
 
class Periodic :
    public physical::Class< Periodic >,
    protected VirtualBase
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(physical,
        Periodic)
 
    
    static TimeUS GetDefaultInterval();
 
    static Properties GetClassProperties();
 
    Periodic(TimeUS interval = GetDefaultInterval());
 
    virtual ~Periodic();
 
    virtual void InitializeImplementation(ByteStreams args);
 
    virtual Code Peak()
    {
 
        //     YOU CODE GOES HERE!
 
        return code::NotImplemented();
    }
 
    virtual void CheckIn();
 
    virtual void SetInterval(TimeUS interval);
 
    TimeUS GetInterval() const;
 
    Timestamp GetTimeLastPeaked() const;
 
    float GetIntervalInSeconds() const;
 
    virtual void SetLastPeakTimestamp(Timestamp lastPeak);
 
    virtual Symmetry* Spin() const;
 
    virtual Code Reify(Symmetry* symmetry);
 
    virtual Properties GetProperties() const;
 
protected:
    TimeUS m_interval;
    Timestamp m_lastPeakTimestamp;
};
 
} //physical namespace
} //bio namespace