core.math.clamp¶

Inputs¶

Name	Type	Title	Mandatory	Description
input	core.type.f64	Input	True	None
min	core.type.f64	Minimum value	True	None
max	core.type.f64	Maximum value	True	None

Outputs¶

Name	Type	Title	Description
output	core.type.f64	Output	None

Parameters¶

Function has no parameters

State variables¶

Function has no state variables

Usage XML code snippet¶

core_math_clamp snippet for FLOW configuration file¶

<f name="clamp" by_spec="core.math.clamp">
    <in alias="input">some_block_1/output</in>
    <in alias="min">some_block_2/output</in>
    <in alias="max">some_block_3/output</in>
</f>

Function’s artifacts¶

Declaration for core_math_clamp
Implementation for core_math_clamp
Header of core_math_clamp
Specification of core_math_clamp
Interface of core_math_clamp

declaration.py¶

from fspeclib import *


Function(
    name='core.math.clamp',
    title=LocalizedString(
        en='Clamp number into range'
    ),
    description=None,
    inputs=[
        Input(
            name='input',
            title='Input',
            value_type='core.type.f64'
        ),
        Input(
            name='min',
            title='Minimum value',
            value_type='core.type.f64'
        ),
        Input(
            name='max',
            title='Maximum value',
            value_type='core.type.f64'
        )
    ],
    outputs=[
        Output(
            name='output',
            title='Output',
            value_type='core.type.f64'
        )
    ]
)

core_math_clamp_exec.c¶

#include "core_math_clamp.h"

void core_math_clamp_exec(
    const core_math_clamp_inputs_t *i,
    core_math_clamp_outputs_t *o
)
{
    if (i->input <= i->min) {
        o->output = i->min;
    } else if (i->input >= i->max) {
        o->output = i->max;
    } else {
        o->output = i->input;
    }
}

core_math_clamp.h¶

/**
 *  Automatically-generated file. Do not edit!
 */

#ifndef FSPEC_CORE_MATH_CLAMP_H
#define FSPEC_CORE_MATH_CLAMP_H

#include <stdint.h>
#include <eswb/types.h>

#include "function.h"

/* Include declaration of dependency types */
#include "core_type_f64.h"

/**
 * @brief Inputs of `core.math.clamp` function
 */
typedef struct core_math_clamp_inputs_ {
    core_type_f64_t input;  /// Input
    core_type_f64_t min;  /// Minimum value
    core_type_f64_t max;  /// Maximum value

} core_math_clamp_inputs_t;

/**
 * @brief Outputs of `core.math.clamp` function
 */
typedef struct core_math_clamp_outputs_ {
    core_type_f64_t output; /// Output

} core_math_clamp_outputs_t;

typedef struct core_math_clamp_eswb_descriptors_ {
    eswb_topic_descr_t in_input;
    eswb_topic_descr_t in_min;
    eswb_topic_descr_t in_max;
    eswb_topic_descr_t out_all;
} core_math_clamp_eswb_descriptors_t;

typedef struct core_math_clamp_interface_ {
    core_math_clamp_inputs_t i;
    core_math_clamp_outputs_t o;
    core_math_clamp_eswb_descriptors_t eswb_descriptors;
} core_math_clamp_interface_t;

void core_math_clamp_exec(const core_math_clamp_inputs_t *i, core_math_clamp_outputs_t *o);

#endif // FSPEC_CORE_MATH_CLAMP_H

core_math_clamp_spec.c¶

/**
 *  Automatically-generated file. Do not edit!
 */

#include "core_math_clamp.h"
#include <eswb/types.h>

static const param_spec_t *params[1] = {
    NULL
};

static const input_spec_t i_input = {
    .name = "input",
    .annotation = "Input",
    .flags = 0
};

static const input_spec_t i_min = {
    .name = "min",
    .annotation = "Minimum value",
    .flags = 0
};

static const input_spec_t i_max = {
    .name = "max",
    .annotation = "Maximum value",
    .flags = 0
};

static const input_spec_t *inputs[4] = {
    &i_input,
    &i_min,
    &i_max,
    NULL
};

static const output_spec_t o_output = {
    .name = "output",
    .annotation = "Output",
    .flags = 0
};

static const output_spec_t *outputs[2] = {
    &o_output,
    NULL
};

fspec_rv_t core_math_clamp_call_init_inputs(
    void *dh,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td
);

fspec_rv_t core_math_clamp_call_init_outputs(
    void *dh,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td,
    const char *func_name
);

void core_math_clamp_call_exec(void *dh);

const function_spec_t atomic_core_math_clamp_spec = {
    .name = "core.math.clamp",
    .annotation = "Clamp number into range",
    .inputs = inputs,
    .outputs = outputs,
    .params = params
};

const function_calls_t atomic_core_math_clamp_calls = {
    .interface_handle_size = sizeof(core_math_clamp_interface_t),
    .init = NULL,
    .init_inputs = core_math_clamp_call_init_inputs,
    .init_outputs = core_math_clamp_call_init_outputs,
    .pre_exec_init = NULL,
    .exec = core_math_clamp_call_exec,
    .set_params = NULL
};

const function_handler_t atomic_core_math_clamp_handler = {
    .spec = &atomic_core_math_clamp_spec,
    .calls = &atomic_core_math_clamp_calls,
    .extension_handler = NULL
};

core_math_clamp_interface.c¶

/**
 *  Automatically-generated file. Do not edit!
 */

#include "core_math_clamp.h"

#include "error.h"
#include <eswb/api.h>
#include <eswb/topic_proclaiming_tree.h>
#include <eswb/errors.h>

int core_math_clamp_interface_inputs_init(
    core_math_clamp_interface_t *interface,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td
)
{
    eswb_rv_t rv;
    int errcnt_no_topic = 0;
    int errcnt_no_input = 0;
    const char *topic_path_in_input = fspec_find_path2connect(conn_spec,"input");
    const char *topic_path_in_min = fspec_find_path2connect(conn_spec,"min");
    const char *topic_path_in_max = fspec_find_path2connect(conn_spec,"max");

    // Connecting mandatory input "input"
    if (topic_path_in_input != NULL) {
        rv = eswb_connect_nested(mounting_td, topic_path_in_input, &interface->eswb_descriptors.in_input);
        if(rv != eswb_e_ok) {
            error("failed connect input \"input\" to topic \"%s\": %s", topic_path_in_input, eswb_strerror(rv));
            errcnt_no_topic++;
        }
    } else {
        error("mandatory input \"input\" is not speicifed");
        errcnt_no_input++;
    }

    // Connecting mandatory input "min"
    if (topic_path_in_min != NULL) {
        rv = eswb_connect_nested(mounting_td, topic_path_in_min, &interface->eswb_descriptors.in_min);
        if(rv != eswb_e_ok) {
            error("failed connect input \"min\" to topic \"%s\": %s", topic_path_in_min, eswb_strerror(rv));
            errcnt_no_topic++;
        }
    } else {
        error("mandatory input \"min\" is not speicifed");
        errcnt_no_input++;
    }

    // Connecting mandatory input "max"
    if (topic_path_in_max != NULL) {
        rv = eswb_connect_nested(mounting_td, topic_path_in_max, &interface->eswb_descriptors.in_max);
        if(rv != eswb_e_ok) {
            error("failed connect input \"max\" to topic \"%s\": %s", topic_path_in_max, eswb_strerror(rv));
            errcnt_no_topic++;
        }
    } else {
        error("mandatory input \"max\" is not speicifed");
        errcnt_no_input++;
    }

    if ((errcnt_no_input > 0) || (errcnt_no_topic > 0)) {
        if (errcnt_no_input > errcnt_no_topic) {
            return fspec_rv_no_input;
        } else {
            return fspec_rv_no_topic;
        }
    }
    return fspec_rv_ok;
}

fspec_rv_t core_math_clamp_interface_inputs_update(core_math_clamp_interface_t *interface)
{
    eswb_rv_t rv;

    rv = eswb_read(interface->eswb_descriptors.in_input, &interface->i.input);
    if(rv != eswb_e_ok) {
        /*FIXME nothing to do yet*/
    }

    rv = eswb_read(interface->eswb_descriptors.in_min, &interface->i.min);
    if(rv != eswb_e_ok) {
        /*FIXME nothing to do yet*/
    }

    rv = eswb_read(interface->eswb_descriptors.in_max, &interface->i.max);
    if(rv != eswb_e_ok) {
        /*FIXME nothing to do yet*/
    }

    return 0;
}

fspec_rv_t core_math_clamp_interface_outputs_init(
    core_math_clamp_interface_t *interface,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td,
    const char *func_name
)
{
    TOPIC_TREE_CONTEXT_LOCAL_DEFINE(cntx, 2);
    core_math_clamp_outputs_t out;
    eswb_rv_t rv;

    topic_proclaiming_tree_t *rt = usr_topic_set_struct(cntx, out, func_name);

    usr_topic_add_struct_child(cntx, rt, core_math_clamp_outputs_t, output, "output", tt_double);
    rv = eswb_proclaim_tree(mounting_td, rt, cntx->t_num, &interface->eswb_descriptors.out_all);
    if (rv != eswb_e_ok) {
        return fspec_rv_publish_err;
    }

    return fspec_rv_ok;
}

fspec_rv_t core_math_clamp_interface_outputs_update(core_math_clamp_interface_t *interface)
{
    eswb_rv_t rv;

    rv = eswb_update_topic(interface->eswb_descriptors.out_all, &interface->o);
    if (rv != eswb_e_ok) {
        return 1;
    }

    return 0;
}

void core_math_clamp_interface_update(core_math_clamp_interface_t *interface)
{
    core_math_clamp_interface_inputs_update(interface);
    core_math_clamp_exec(&interface->i, &interface->o);
    core_math_clamp_interface_outputs_update(interface);
}

fspec_rv_t core_math_clamp_call_init_inputs(
    void *dh,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td
)
{
    core_math_clamp_interface_t *interface = (core_math_clamp_interface_t*) dh;
    return core_math_clamp_interface_inputs_init(interface, conn_spec, mounting_td);
}

fspec_rv_t core_math_clamp_call_init_outputs(
    void *dh,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td,
    const char *func_name
)
{
    core_math_clamp_interface_t *interface = (core_math_clamp_interface_t*) dh;
    return core_math_clamp_interface_outputs_init(interface, conn_spec, mounting_td, func_name);
}

void core_math_clamp_call_exec(void *dh)
{
    core_math_clamp_interface_t *interface = (core_math_clamp_interface_t*) dh;
    core_math_clamp_interface_update(interface);
}

← core.math.atan2 core.math.cos →