event.h

Go to the documentation of this file.

/********************************************************************
* Copyright (C) 2015 by Interstel Technologies, Inc.
*   and Hawaii Space Flight Laboratory.
*
* This file is part of the COSMOS/core that is the central
* module for COSMOS. For more information on COSMOS go to
* <http://cosmos-project.com>
*
* The COSMOS/core software is licenced under the
* GNU Lesser General Public License (LGPL) version 3 licence.
*
* You should have received a copy of the
* GNU Lesser General Public License
* If not, go to <http://www.gnu.org/licenses/>
*
* COSMOS/core is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* COSMOS/core 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
* Lesser General Public License for more details.
*
* Refer to the "licences" folder for further information on the
* condititons and terms to use this software.
********************************************************************/

#ifndef COSMOS_COMMAND_H
#define COSMOS_COMMAND_H



#include "support/configCosmos.h"
#include "support/jsonlib.h"
#include "support/jsonobject.h"

using std::string;

#define MAXCOMMANDWORD 20

namespace Cosmos {


class Event {

public: // TODO: consider private?

    double      mjd;
    double      utcexec=0.;
    string      name;
    uint32_t    type;
    uint32_t    flag;
    string      data;
    string      condition;
    bool        already_ran;
    uint32_t true_count=0;
    string      event_string;

public:

    Event();

    ~Event();


    void    set_command(string jstring);


    void    set_utcexec()   {   utcexec = currentmjd(0.);   }


    void    set_actual()    {   flag |= EVENT_FLAG_ACTUAL;  }


    string  get_name()      {   return name; }


    string  get_event_string();


    double  getUtc()        {   return mjd; }


    string  getTime()       {   return mjd2iso8601( getUtc() ); }


    double  getUtcExec()    {   return utcexec; }


    string  get_data()      {   return data; }


    bool    is_ready()      {   return (mjd <= currentmjd(0.)); }


    bool    is_repeat()     {   return (flag & EVENT_FLAG_REPEAT);  }


    bool    is_command()    {   return (type & EVENT_TYPE_COMMAND); }


    bool    is_conditional(){   return (flag & EVENT_FLAG_CONDITIONAL); }


    bool    is_solo(){  return (flag & EVENT_FLAG_SOLO);    }


    bool    is_alreadyrun(){    return (flag & EVENT_FLAG_TRUE);    }
    void    set_alreadyrun(bool value){ if (value) flag |= EVENT_FLAG_TRUE; else flag &= ~EVENT_FLAG_TRUE; }

    string generator(
        string name,
        string data,
        double utc,
        string condition,
        uint32_t flag
    );

    string generator(eventstruc event);

    // JIMNOTE: this function (condition_true)  needs a look at....
    // OLDNOTE: seems to return nan from json_equation...  how to use?
    bool condition_true(cosmosstruc *cinfo);


    friend std::ostream& operator<<(std::ostream& out, const Event& cmd);


    friend bool operator==(const Event& cmd1, const Event& cmd2);

}; // end of class Event

} // end of namepsace Cosmos

#endif // COSMOS_COMMAND_H