afw_interface_common.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Interface Common Header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_INTERFACE_COMMON_H__
#define __AFW_INTERFACE_COMMON_H__
 
#include "afw_common.h"
 
AFW_BEGIN_DECLARES
 
typedef struct afw_interface_rti_variable_s {
    const afw_utf8_z_t * name;
    const afw_utf8_z_t * type;
    const afw_utf8_z_t * c_declaration;
    const afw_utf8_z_t * description;
} afw_interface_rti_variable_t;
 
 
typedef struct afw_interface_rti_method_s {
    const afw_utf8_z_t * name;
    const afw_interface_rti_variable_t * const (*parameters);
    const afw_utf8_z_t * description;
} afw_interface_rti_method_t;
 
 
typedef struct afw_interface_rti_s {
    const afw_utf8_z_t * name;
    const afw_utf8_z_t * id;
    const afw_interface_rti_variable_t * const (*variables);
    const afw_interface_rti_method_t * const (*methods);
} afw_interface_rti_t;
 
 
typedef struct afw_interface_implementation_rti_s {
    const afw_utf8_t interface_name;
    const afw_utf8_t implementation_source;
    const afw_utf8_t implementation_id;
    const void      *implementation_specific;
} afw_interface_implementation_rti_t;
 
 
typedef struct afw_interface_s {
    afw_interface_implementation_rti_t rti;
    /* Function pointer for each method. */
} afw_interface_t;
 
 
typedef struct afw_instance_s {
    const afw_interface_t *inf;
    /* There may be additional public instance info. */
} afw_instance_t;
 
 
AFW_END_DECLARES
 
#endif /* __AFW_INTERFACE_COMMON_H__ */