Changeset 8152

Timestamp:

08/07/08 14:51:23 (5 years ago)

Author:

mcarrick

Message:

finished editing component instructions

Files:

• documentation/ossie/user-guide-0.7.0/OEFGuide.tex (modified) (2 diffs)

documentation/ossie/user-guide-0.7.0/OEFGuide.tex

@@ -116 +116 @@
 \end{center}
 
-
 Now the default value for the gain must be entered. Click on the clear blank text box under Default value in the Properties panel, and enter 1.
 
@@ -131 +130 @@
 \subsubsection{Generating the Source Code}
 \label{section:oef:generatesourcecode}
-
-
+On the OEF toolbar, select OSSIE : Generate Component. This generates all of the files for the component in the local eclipse workspace directory.
+
+Generating the component will produce multiple files along with the source code.
+\begin{enumerate}
+\item {\tt configure.ac}: This is the script that autoconf uses to generate the configure file. It checks for dependencies such as which compiler to use, as well as the presence of OSSIE libraries.
+\item {\tt Makefile.am}: This is the script that automake uses to generate the Makefile. It includes all the source files for the component.
+\item {\tt reconf}: This is a script to run the automake tools.
+\item {\tt component\_name.h}: Component class header file.
+\item {\tt component\_name.cpp}: Component class implementation definition.
+\item {\tt main.cpp}: Contains the mandatory {\tt int main()} definition.
+\item {\tt component\_name.prf.xml}: Component property file.
+\item {\tt component\_name.scd.xml}: Software component descriptor.
+\item {\tt component\_name.spd.xml}: Software package descriptor.
+\item {\tt documentation.txt}: File for documenting your component.
+\item {\tt Doxyfile}: Doxygen file for generating documentation.
+\end{enumerate}
+Additional files are generated when using the {\tt pyi\_comp} option:
+\begin{enumerate}
+\item {\tt component\_name.py}: Python file with port implementations.
+\item {\tt WorkModule.py}: Python file where processing is done.
+\item {\tt setup.py}: Install script used to copy Python and XML files into the appropriate subdirectories under {\tt /sdr} once the component is edited to provide functionality. This is executed by typing {\tt python setup.py install}.
+\end{enumerate} 
+
+At this point the signal processing or logical function of the component must be defined. The process for doing so is different depending on whether the component is written in C++ or python.
+
+\subsubsection{Editing C++ Components}
+\label{section:oef:editingccomponent}
+In this example, by selecting {\tt basic\_ports} the component was generated as a C++ component. To edit the component, open {\tt component\_name.cpp} and find the {\tt ProcessData} function.
+\begin{lstlisting}[]
+$ cd /path/to/OEF/workspace/component_name/
+$ vim component_name.cpp
+\end{lstlisting}
+
+Within the function, there will be a {\tt while} loop and inside of it will be a line:
+\begin{lstlisting}[]
+/*insert code here to do work*/
+\end{lstlisting}
+This is where the signal processing function should be implemented. The property that was generated, {\tt gain} will be availble in the source code initially as {\tt simplei\_0\_value}. Reassign this to a new variable named {\tt gain} in the {\tt configure} function in the same file.
+
+\subsubsection{Editing Python Components}
+\label{section:oef:editpythoncomponents}
+Generated component template code must be modified to
+process data. The instructions here apply to a very basic Python component with
+one {\it uses} and one {\it provides} port and no properties.  Property values
+can be used in the processing operations, but this will be the subject of a
+future excercise.
+
+All data coming into a {\it provides} port will be loaded into the
+WorkModule buffer.  The data going into this buffer will be loaded
+into variables called I and Q.  See the generated WorkModule.py and
+look for:
+\begin{lstlisting}[]
+    I = new_data[0]
+    Q = new_data[1]
+\end{lstlisting}
+This implies that if you try to run a component that is getting real
+data only, Q should be empty, and this may even cause an error.  There are
+comments in various parts of the python files describing how to adjust your code
+appropriately.
+
+The next two lines initialize two arrays to store your new data:
+\begin{lstlisting}[]
+    newI = [0 for x in range(len(I)))]
+    newQ = [0 for x in range(len(Q)))]
+\end{lstlisting}
+%TODO: Make listings highlighted
+Following these lines are comments with an example of how to
+process data.  If you uncomment the 3-line example, your
+component will pass the data received by the {\it provides} (input) port to the
+{\it uses} (output) port, assuming you have one {\it uses} port of type {\tt
+complexShort} and one {\it provides} port, also of type {\tt complexShort}.
+Code can be added to process the data.
+
+The next set of lines following the comment ``{\tt \# Output the new data},''
+will send the {\tt newI} and {\tt newQ} vectors to all of your output ports.
+
+\subsubsection{Editing the SPD File}
+
+You will need to edit {\tt MyComponent.spd.xml} before your Python
+component will work properly.  Find the XML tag below the tag {\tt <code
+type="'Executable"'>}. By default the next tag is:
+\begin{lstlisting}[]
+ <localfile name="'bin/MyComponent"'/>}
+\end{lstlisting}
+This needs to be changed to:
+\begin{lstlisting}[]
+ <localfile name="'bin/MyComponent/MyComponent.py"'/>
+\end{lstlisting}
+
+\subsubsection{Making Sure Files are Executable}
+
+After you have installed the component (see below), you will need to make sure
+that you have permission to execute the Python files.  To do this, navigate to
+{\tt /sdr/bin/MyComponent} and type:
+\begin{lstlisting}[]
+ $ chmod +x *.py
+\end{lstlisting}
+
+\subsubsection{Installing a Component}
+\label{section:oef:installcomponent}
+After the component has been edited, it must be compiled and installed to {\tt /sdr}. To do this, move into the component's workspace directory and run the automake tools.
+\begin{lstlisting}[]
+$ cd /path/to/eclipse/workspace/component_name/
+$ ./reconf
+$ ./configure
+$ make
+$ make install
+\end{lstlisting} 
+
+If the commands execute successfully, the component will be installed to {\tt /sdr} and it will be possible to use the component in a waveform. Start a new waveform in OEF to verify that the component has been installed correctly.
 
 \subsection{Additional OEF Instruction}