core.source.constant¶

Inputs¶

Function has no inputs

Outputs¶

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

Parameters¶

Name	Type	Title	Mandatory	Default value	Description
value	core.type.f64	Constant value	True	None	None

State variables¶

Function has no state variables

Usage XML code snippet¶

core_source_constant snippet for FLOW configuration file¶

<f name="constant" by_spec="core.source.constant">
    <param alias="value">0.0</param>
</f>

Function’s artifacts¶

Declaration for core_source_constant
Implementation for core_source_constant
Set parameters code for core_source_constant
Header of core_source_constant
Specification of core_source_constant
Other
- Interface of core_source_constant

declaration.py¶

from fspeclib import *


Function(
    name='core.source.constant',
    title=LocalizedString(
        en='Number constant'
    ),
    description=None,
    parameters=[
        Parameter(
            name='value',
            title='Constant value',
            value_type='core.type.f64'
        )
    ],
    outputs=[
        Output(
            name='output',
            title='Output',
            value_type='core.type.f64'
        )
    ]
)

core_source_constant_exec.c¶

#include "core_source_constant.h"

void core_source_constant_exec(
    core_source_constant_outputs_t *o,
    const core_source_constant_params_t *p
)
{
    o->output = p->value;
}

core_source_constant_set_params.c¶

#include "core_source_constant.h"
#include "conv.h"

#include <string.h>

#include "error.h"

fspec_rv_t core_source_constant_set_params(
    core_source_constant_params_t *params,
    const func_param_t *param_pairs,
    int initial_call
)
{
    // Get parameters
    core_source_constant_params_t p = *params;

    core_source_constant_params_flags_t flags;
    memset(&flags, 0, sizeof(flags));

    int violation_count = 0;
    conv_rv_t crv = conv_rv_ok;

    // Parse parameters
    for (int i = 0; param_pairs[i].alias != NULL; i++) {
        if (strcmp(param_pairs[i].alias, "value") == 0) {
            if ((crv = conv_str_double(param_pairs[i].value, &p.value)) == conv_rv_ok) {
                flags.changed_param_value = 1;
            }
        } else {
            error("failed unsupported parameter '%s'", param_pairs[i].alias);
            violation_count ++;
        }

        if (crv != conv_rv_ok) {
            error("Parameter '%s' format error (%s)", param_pairs[i].alias, param_pairs[i].value);
            violation_count++;
        }
    }

    if (initial_call) {
        // Check all mandatory parameters are set
        if (!flags.changed_param_value) {
            error("failed missed mandatory parameter 'value'");
            violation_count ++;
        }
    }

    if (violation_count > 0) {
        return fspec_rv_inval_param;
    }

    // Set parameters
    *params = p;

    return fspec_rv_ok;
}

core_source_constant.h¶

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

#ifndef FSPEC_CORE_SOURCE_CONSTANT_H
#define FSPEC_CORE_SOURCE_CONSTANT_H

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

#include "function.h"

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

/**
 * @brief Parameters of `core.source.constant` function
 */
typedef struct core_source_constant_params_{
    core_type_f64_t value;  /// Constant value
} core_source_constant_params_t;

/**
 * @brief Outputs of `core.source.constant` function
 */
typedef struct core_source_constant_outputs_ {
    core_type_f64_t output; /// Output

} core_source_constant_outputs_t;

/**
 * @brief Parameter flags of `core.source.constant` function
 */
typedef struct core_source_constant_params_flags_ {
    uint64_t changed_param_value:1;
} core_source_constant_params_flags_t;

typedef struct core_source_constant_eswb_descriptors_ {
    eswb_topic_descr_t out_all;
} core_source_constant_eswb_descriptors_t;

typedef struct core_source_constant_interface_ {
    core_source_constant_outputs_t o;
    core_source_constant_params_t p;
    core_source_constant_eswb_descriptors_t eswb_descriptors;
} core_source_constant_interface_t;

fspec_rv_t core_source_constant_set_params(
    core_source_constant_params_t *params,
    const func_param_t *param_pairs,
    int initial_call
);

void core_source_constant_exec(core_source_constant_outputs_t *o, const core_source_constant_params_t *p);

#endif // FSPEC_CORE_SOURCE_CONSTANT_H

core_source_constant_spec.c¶

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

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

static const param_spec_t param_value = {
    .name = "value",
    .default_value = "0.0",
    .annotation = "Constant value",
    .flags = 0
};

static const param_spec_t *params[2] = {
    &param_value,
    NULL
};

static const input_spec_t *inputs[1] = {
    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_source_constant_call_init_outputs(
    void *dh,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td,
    const char *func_name
);

void core_source_constant_call_exec(void *dh);

fspec_rv_t core_source_constant_call_set_params(void *dh, const func_param_t *param_pairs, int initial_call);

const function_spec_t atomic_core_source_constant_spec = {
    .name = "core.source.constant",
    .annotation = "Number constant",
    .inputs = inputs,
    .outputs = outputs,
    .params = params
};

const function_calls_t atomic_core_source_constant_calls = {
    .interface_handle_size = sizeof(core_source_constant_interface_t),
    .init = NULL,
    .init_inputs = NULL,
    .init_outputs = core_source_constant_call_init_outputs,
    .pre_exec_init = NULL,
    .exec = core_source_constant_call_exec,
    .set_params = core_source_constant_call_set_params
};

const function_handler_t atomic_core_source_constant_handler = {
    .spec = &atomic_core_source_constant_spec,
    .calls = &atomic_core_source_constant_calls,
    .extension_handler = NULL
};

core_source_constant_interface.c¶

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

#include "core_source_constant.h"

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

fspec_rv_t core_source_constant_interface_outputs_init(
    core_source_constant_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_source_constant_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_source_constant_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_source_constant_interface_outputs_update(core_source_constant_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_source_constant_interface_update(core_source_constant_interface_t *interface)
{
    core_source_constant_exec(&interface->o, &interface->p);
    core_source_constant_interface_outputs_update(interface);
}

fspec_rv_t core_source_constant_call_set_params(void *dh, const func_param_t *param_pairs, int initial_call)
{
    core_source_constant_interface_t *interface = (core_source_constant_interface_t*) dh;
    return core_source_constant_set_params(&interface->p, param_pairs, initial_call);
}

fspec_rv_t core_source_constant_call_init_outputs(
    void *dh,
    const func_conn_spec_t *conn_spec,
    eswb_topic_descr_t mounting_td,
    const char *func_name
)
{
    core_source_constant_interface_t *interface = (core_source_constant_interface_t*) dh;
    return core_source_constant_interface_outputs_init(interface, conn_spec, mounting_td, func_name);
}

void core_source_constant_call_exec(void *dh)
{
    core_source_constant_interface_t *interface = (core_source_constant_interface_t*) dh;
    core_source_constant_interface_update(interface);
}

← core.quat.to_euler core.source.meander →