Changes between Version 7 and Version 8 of C++ API

Timestamp:

09/10/12 18:53:58 (12 years ago)

Author:

jorisborgdorff

Comment:

--

C++ API

@@ -10 +10 @@
 void MUSCLE_Finalize(void);
 
-const char* MUSCLE_Get_Kernel_Name(void);
+const char* MUSCLE_Kernel_Name(void);
 const char* MUSCLE_Get_Property(const char* name);
 int MUSCLE_Will_Stop(void);
@@ -27 +27 @@
 }
 }}}
-After this, any code can be written. The MUSCLE_Get_Kernel_Name function gives the current kernel name. This must be freed after use. Similarly, MUSCLE_Get_Property gives a property as a string, which must be freed afterwards.
+After this, any code can be written. The {{{MUSCLE_Kernel_Name}}} function gives the current kernel name. This must be freed after use. Similarly, MUSCLE_Get_Property gives a property as a string, which must be freed afterwards.
 
 The send and receive functions can transport several datatypes, which are enumerated in {{{muscle2/muscle_types.h}}}. For reference, it takes the following datatypes
@@ -96 +96 @@
 
 std::string muscle::env::get_tmp_path(void);
+
+std::string muscle::cxa::get_property(std::string name);
+std::string muscle::cxa::get_properties(void);
+std::string muscle::cxa::kernel_name(void);
+
 }}}
-{{{init}}}, {{{finalize}}}, {{{will_stop}}}, {{{send}}}, and {{{receive}}} behave exactly as their C counterparts. Since scientific data is often vectors of doubles, there are two new convenience functions to send or receive only double vectors. Vectors are safer than arrays memory-wise and they do range-checking. If other vector methods are of interest to you, send us [[mailto:j.borgdorff@uva.nl|an email]]. Except for vectors, the data that is received must be freed by MUSCLE by calling {{{free_data}}} with the received pointer and the datatype of the received pointer.
+{{{init}}}, {{{finalize}}}, {{{will_stop}}}, {{{send}}}, {{{receive}}}, {{{get_property}}}, and {{{kernel_name}}} behave exactly as their C counterparts. Since scientific data is often vectors of doubles, there are two new convenience functions to send or receive only double vectors. Vectors are safer than arrays memory-wise and they do range-checking. If other vector methods are of interest to you, send us [[mailto:j.borgdorff@uva.nl|an email]]. Except for vectors, the data that is received must be freed by MUSCLE by calling {{{free_data}}} with the received pointer and the datatype of the received pointer.
 
 === Complex data ===
@@ -153 +158 @@
 muscle::env::send("matrixOut", &cdata, cdata.length(), MUSCLE_COMPLEX);
 }}}
+
+=== Logger ===
+
+MUSCLE provides logging facilities for C++. The functions are all static.
+{{{
+void muscle::logger::severe(std::string message, ...);
+void muscle::logger::warning(std::string message, ...);
+void muscle::logger::info(std::string message, ...);
+void muscle::logger::config(std::string message, ...);
+void muscle::logger::fine(std::string message, ...);
+void muscle::logger::finer(std::string message, ...);
+void muscle::logger::finest(std::string message, ...);
+}}}
+Each takes a message, and optionally more arguments provided in printf syntax. For instance:
+{{{
+muscle::logger::info("the temporary path is %s", muscle::env::get_tmp_path().c_str());
+}}}
+This will print the message to stdout and prepend the current kernel name and the log level. A planned feature is to write this output to a fixed file.