Versions Compared

Old Version 3

changes.mady.by.user Bartosz Palak

Saved on

compared with

New Version Current

changes.mady.by.user Bartosz Palak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

3 Development of C++ codes3

4.2.1

Function syntax

Changes

void name ( <in/out arguments list> [,code_parameters] [,diagnostic_info] )

  • name - function name
  • code_parameters - optional - user defined input parameters
  • diagnostic_info -  arbitrary output diagnostic information

3.2 Arguments list

CHEAT SHEET
ITMIMAS
#include "UALClasses.h"#include "UALClasses.h"
ItmNs::Itm::<cpo> cpo;
IdsNs::IDS::<ids> ids;
  • in/out arguments list
  •  mandatory
    • a list of input and output function arguments including:
  • CPP intrisic data types, eg:
    • int &x
    • double &y
    • IDSes, eg:Argument of type: 
    ItmNs::Itm::
    antennas & ant
  • ItmNs::Itm::equilibriumArray & eq
    • 3.3 Code parameters
  • Optional
  • User defined input parameters
    • <cpo>Array cpoArray;  <= Array!
    IdsNs::IDS::<ids> ids; <= Single obj !
    ItmNs::codeparam_t & 
     Code Block
    languagecpp
    typedef struct {
        char **parameters;
        char **default_param;
        char **schema;
    } codeparam_t;
     
     
  • A structure codeparam_t describes:
    • parameters - Actual value of the code parameters (instance of coparam/parameters in XML format).
    • default_param - Default value of the code parameters (instance of coparam/parameters in XML format).
    • schema - Code parameters schema.
    • codeparamIdsNs::codeparam_t & codeparam
    eval-pkg-config
    pkg-config
    eval-pkg-config --cflags --libs ual-cpp-gnu
    pkg-config --cflags --libs imas-cpp
      
     
    4.2.2 Examples
    Examples of interface between wrapper and user code
     Code Block
    languagecpp
    titleITM
    linenumberstrue
    /**** Simple types ***/
void simple(double &x, double &y)

/**** Single slice ***/
void slice( ItmNs::Itm::equilibrium &eq)

/**** Array of slices ***/
void slice_array( ItmNs::Itm::equilibriumArray &eq)

/**** Code XML parameters ***/
void code_params(...., ItmNs::codeparam_t& param)

/**** Arbitrary diagnostic info ***/
void diag_info
  • An example: ItmNs::codeparam_t & codeparam
    • 3.4 Diagnostic info
  • arbitrary output diagnostic information
    • output / optional
     Code Block
    languagecpp
     void name
    (...., int* 
    output_flag
    outFlag, char** 
    diagnostic_info)
  • output_flag - indicates if user subroutine was successfully executed
    • output_flag = 0  - SUCCESS, no action is taken
    • output_flag > 0  - WARNING, a warning message is displayed, workflow continuue execution
    • output_flag < 0  - ERROR, actor throws an exception, workflow stops
  • diagnostic_info - an arbitrary string
    •  Warning
    Required header
    Do not forget to add #include "UALClasses.h" while playing with IDSes!
     
     
    3.5 Examples
     
     
    diagInfo)
     Code Block
    languagecpp
    title
    Example 4. Simple in/out argument types
    IMAS
    linenumberstrue
    /**** Simple types ***/
void simple
    void simplecppactornoids
    (double &x, double &y)
     Code Block
    languagecpp
    title Example 5. A IDS array as a function argument
    void simplecppactor(ItmNs::Itm
    

/**** Single slice ***/
void slice(IdsNs::IDS::equilibrium &eq
    , double &x, double &y)

     Code Block
    languagecpp
    titleExample 6. Usage of init function and code input parameters
    void mycppfunctionbis_init();

void mycppfunction(ItmNs::Itm::summary& sum, ItmNs::Itm::equilibrium& eq, int& x, ItmNs::Itm::coreimpur& cor,  double&  y, ItmNs::codeparam_t& codeparam)
     Info
    Initialization
    If user function needs any pre-initialization, an additional function <name>_init could be defined.
     
    ...
    )

/**** Array of slices ***/
void slice_array( IdsNs::IDS:equilibrium &eq)

/**** Code XML parameters ***/
void code_params(...., IdsNs::codeparam_t& param)
 
/**** Arbitrary diagnostic info ***/
void diag_info(...., int* outFlag, char** diagInfo)
    4.2.3 Delivery of the user code
    The user code should be delivered as a static library.
    Please find examples of the simple "Makefile" below:
     
     Code Block
    titleExample 7. Building of C++ code
    CXX=g++
CXXFLAGS= -g -fPIC
CXXINCLUDES= ${shell pkg-config --cflags imas-cpp}

all: libsimplecppactor.a

libsimplecppactor.a: simplecppactor.o
        ar -rvs $@ $^

simplecppactor.o: simplecppactor.cpp
        $(CXX) $(CXXFLAGS) $(CXXINCLUDES) -c -o $@ $^

clean:
        rm *.a *.o