juno_sch_api.h

Go to the documentation of this file.

/*
    MIT License
 
    Copyright (c) 2025 Robin A. Onsay
 
    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.
*/
 
#ifndef JUNO_SCH_API_H
#define JUNO_SCH_API_H
#include "juno/app/app_api.h"
#include "juno/status.h"
#include "juno/module.h"
#include "juno/time/time_api.h"
#include "juno/types.h"
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct JUNO_SCH_API_TAG JUNO_SCH_API_T;
 
typedef struct JUNO_SCH_ROOT_TAG JUNO_SCH_ROOT_T;
 
// @{"req": ["REQ-SCH-003"]}
#define JUNO_SCH_TABLE_NEW(ptArrName, zAppsPerMinorFrame, zNumMinorFrames, ...) \
JUNO_APP_ROOT_T *ptArrName[zNumMinorFrames * zAppsPerMinorFrame] = {__VA_ARGS__}
 
// @{"req": ["REQ-SCH-001", "REQ-SCH-007"]}
struct JUNO_SCH_ROOT_TAG JUNO_MODULE_ROOT(JUNO_SCH_API_T,
    JUNO_TIME_ROOT_T *ptTime;                 
    JUNO_APP_ROOT_T **ptArrSchTable;          
    size_t zAppsPerMinorFrame;                
    size_t zNumMinorFrames;                   
    JUNO_TIMESTAMP_T tMinorFramePeriod;       
);
 
// @{"req": ["REQ-SCH-002"]}
struct JUNO_SCH_API_TAG
{
    // @{"req": ["REQ-SCH-004"]}
    JUNO_STATUS_T (*Execute)(JUNO_SCH_ROOT_T *ptJunoSch);
    // @{"req": ["REQ-SCH-005"]}
    JUNO_TIMESTAMP_RESULT_T (*GetMinorFramePeriod)(JUNO_SCH_ROOT_T *ptJunoSch);
    // @{"req": ["REQ-SCH-006"]}
    JUNO_TIMESTAMP_RESULT_T (*GetMajorFramePeriod)(JUNO_SCH_ROOT_T *ptJunoSch);
};
 
#ifdef __cplusplus
}
#endif
#endif // JUNO_SCH_API_H