Changes between Version 8 and Version 9 of ObjectDeveloperGuide

Timestamp:

05/11/09 17:46:22 (17 years ago)

Author:

ismael (IP: 192.168.4.1)

Comment:

--

ObjectDeveloperGuide

@@ -17 +17 @@
  * The object reads once the initialization parameters and configures its behaviour.
  * Given a set of parameter values, the object produces an output set of streams as a function of an input set of streams within the defined resource utilization constraints.
-
-== [[BR]]Defining an Object ==
+[[BR]]
+== Defining an Object ==
 Given the previous definition of an object, we define a directory structure for its implementation in order to homogenize objects from several sources and to access easily to useful information. Generating a new object should follow this layout:
 
@@ -28 +28 @@
 ||myobj/Makefile||For compilation||
 
-==  ==
-==  ==
-==  ==
 == Implementing the Object ==
 Once your object has been properly defined, you can begin coding it. Here we assume the reader is familiar with basic ALOE concepts, nevertheless, this section describes how to implement an ALOE Object and provides some examples.
 
-===  ===
 === Process Structure ===
 All the tasks a radio application shall realize must follow the following simple function structure:
@@ -52 +48 @@
 
 Note how the object owns the CPU during the time it process the message. After that, the object returns to the STATUS point handing the CPU over to ALOE again. In anomalous or time rules violation, ALOE may release the ownership from the object before returning to the STATUS point.
-
-'''Figure 3.1 – ALOE Object Flow Diagram'''
 
 === Coding an Object ===
@@ -237 +231 @@
         int filter_type;
 
-        fdi = NewFlow(“input”, FLOW_READ_ONLY);
+        fdi = CreateItf(“input”, FLOW_READ_ONLY);
         if (fdi < 0) {
                 WriteLog(“Error creating flow\n”);
                 return 0;
         }
-        fdo = CreateFlow(“output”, FLOW_WRITE_ONLY);
+        fdo = CreateItf(“output”, FLOW_WRITE_ONLY);
         if (fdo < 0) {
                 WriteLog(“Error creating flow\n”);
                 return 0;
         }
-        fdc = CreateFlow(“control”, FLOW_READ_ONLY);
+        fdc = CreateItf(“control”, FLOW_READ_ONLY);
         if (fdo < 0) {
                 WriteLog(“Error creating flow\n”);
@@ -267 +261 @@
                 return 0;
         }
+
+        /* perform non-realtime computations */
         calc_fir_coefs(fir_coef,filter_type);
-        n = InitStatsFile();
-        if (n < 0) {
-                WriteLog (“Error initiating stats\n”);
-                return 0;
-        }
+
         stat_outsignal = InitStat(“out_signal”);
         if (stat_outsignal < 0) {
@@ -301 +293 @@
                 }
                 /* Read from control interface */
-                n = ReadFlow(fdc, &control, sizeof(struct control_itf));
+                n = ReadItf(fdc, &control, sizeof(struct control_itf));
                 if (n < 0) {
                         WriteLog(“Error reading from control flow\n”);
@@ -311 +303 @@
         /* receive a block of data */
         do {
-                n = ReadFlow(fdi, &input.data[rcv_len], long_in_block - rcv_len);
+                n = ReadItf(fdi, &input.data[rcv_len], long_in_block - rcv_len);
                 if (n < 0) {
                         WriteLog(“Error reading from flow\n”);
@@ -324 +316 @@
         if (rcv_len == long_block) {
                 my_process_function(input, output, fir_coef, long_in_block);
-                n = WriteFlow(fdo, data_out.data, long_out_block);
+                n = WriteItf(fdo, data_out.data, long_out_block);
                 if (n < 0) {
                         LogWrite(“Error writing to flow\n”);
@@ -339 +331 @@
 }
 }}}
-[[BR]]
-[[BR]]
-[[BR]]
-== Coding Style ==
-[[BR]]
 [[BR]]
 [[BR]]
 == Compiling and Linking ==
-[[BR]]
-[[BR]]
-
-[wiki:ALOEImplementations "[Back to ALOE Implementations]"]
+
+Compiling an ALOE objects does not need any other consideration rather than linking with the ALOE SW Library and HW Library. Obviously, we have to pick the HW library of our system. Under linux, and once we have installed ALOE (binary or source), the libraries should appear at /usr/local/lib with the names libsw_api.a and libhw_api.a.
+
+If your prefer to use autoconf/automake tools these files might be useful:
+   * sample configure.in
+   * sample Makefile.am
+
+[wiki:ALOE "[Back to ALOE]"]