appmacros.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC. 
******************************************************************************/
/*
File containing useful macros for math utilities
 
Author: Alex Reynolds
*/
 
#ifndef FLIGHT_APPMACROS_H
#define FLIGHT_APPMACROS_H
 
#include "configuration.h"
 
#define SIGNAL(NAME, TYPE, INITIAL_VALUE) clockwerk::DataIO<TYPE> NAME = clockwerk::DataIO<TYPE>(this, #NAME, INITIAL_VALUE);
#define START_OUTPUTS struct Outputs : clockwerk::GraphTreeObject {\
    Outputs(clockwerk::GraphTreeObject* par, const char* nme) : clockwerk::GraphTreeObject(nme, _children, MAXIMUM_APP_CHILDREN) {parent(par);}\
    private:\
        clockwerk::GraphTreeObject* _children[MAXIMUM_APP_CHILDREN];\
    public:
#define END_OUTPUTS };\
    Outputs outputs = Outputs(this, "outputs");
#define START_INPUTS struct Inputs : clockwerk::GraphTreeObject {\
    Inputs(clockwerk::GraphTreeObject* par, const char* nme) : clockwerk::GraphTreeObject(nme, _children, MAXIMUM_APP_CHILDREN) {parent(par);}\
    private:\
        clockwerk::GraphTreeObject* _children[MAXIMUM_APP_CHILDREN];\
    public:
#define END_INPUTS };\
    Inputs inputs = Inputs(this, "inputs");
#define START_PARAMS struct Params : clockwerk::GraphTreeObject {\
    Params(clockwerk::GraphTreeObject* par, const char* nme) : clockwerk::GraphTreeObject(nme, _children, MAXIMUM_APP_CHILDREN) {parent(par);}\
    private:\
        clockwerk::GraphTreeObject* _children[MAXIMUM_APP_CHILDREN];\
    public:
#define END_PARAMS };\
    Params params = Params(this, "params");

// ----------------- CODE COVERAGE ECXLUSION --------------------------
// Excluded from code review 8/29/2025
// The log macro expands to a two condition if statement which is placed
// everywhere it is called. The two conditions are based on the local
// log level and the overall (executive) log. To exercise both conditions
// would require re-running every test with the local and executive log
// levels separately enabled, which adds no value to overall testing. The internal
// elements of the LOG macro (os syslog) are tested independently, so 
// excluding this macro from code coverage utilities eliminates an undue
// testing burden without lowering the quality of testing or coverage.
// complex
// Author: Alex Reynolds
// Tech Authority: Alex Reynolds
// Reviewer: Will Burken
//TODO Handle strlen when MESSAGE is nullptr or has no terminating bytes
#define LOG(LEVEL, MESSAGE) \
EXCLUDE_FROM_COVERAGE(\
    if(LEVEL <= exc.logLevel() || LEVEL <= _local_log_level /* LCOV_EXCL_LINE */) {\
        exc.os().sysLog(exc.os().systemTime().asFloatingPoint(), name(), MESSAGE, strlen(MESSAGE)); /* LCOV_EXCL_LINE */\
    }\
)
 
// Custom log function defined for the scheduler, which manages executive differently
#define LOG_SCHEDULER(LEVEL, MESSAGE) \
EXCLUDE_FROM_COVERAGE(\
    if(_exc_ptr) {\
        if(LEVEL <= _exc_ptr->logLevel() /* LCOV_EXCL_LINE */) {\
            _exc_ptr->os().sysLog(_exc_ptr->os().systemTime().asFloatingPoint(), name(), MESSAGE, strlen(MESSAGE)); /* LCOV_EXCL_LINE */\
        }\
    }\
)
 
#endif