--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/Makefile Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,173 @@
+EPSTOPDF = epstopdf
+DIA = dia
+CONVERT = convert
+
+SOURCE = source
+FIGURES = $(SOURCE)/figures
+
+# specify figures from which .png and .pdf figures need to be
+# generated (all dia and eps figures)
+IMAGES_EPS = ${FIGURES}/antenna-coordinate-system.eps
+
+# specify figures for build process (all eps figures)
+GRAPHS_EPS =
+
+# rescale pdf figures as necessary
+$(FIGURES)/testbed.pdf_width = 5in
+
+IMAGES_PNG = ${IMAGES_EPS:.eps=.png}
+IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf}
+
+IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF)
+
+%.eps : %.dia; $(DIA) -t eps $< -e $@
+%.png : %.dia; $(DIA) -t png $< -e $@
+%.png : %.eps; $(CONVERT) $< $@
+%.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi
+
+GRAPHS_PNG = ${GRAPHS_EPS:.eps=.png}
+GRAPHS_PDF = ${GRAPHS_EPS:.eps=.pdf}
+
+GRAPHS = $(GRAPHS_EPS) $(GRAPHS_PNG) $(GRAPHS_PDF)
+
+%.png : %.eps; $(CONVERT) $< $@
+%.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCE)
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+ -rm -f $(IMAGES_PNG)
+ -rm -f $(IMAGES_PDF)
+ -rm -f $(GRAPHS_PNG)
+ -rm -f $(GRAPHS_PDF)
+
+frag: pickle
+ @if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi
+ pushd $(BUILDDIR)/frag && ../../pickle-to-xml.py ../pickle/index.fpickle > navigation.xml && popd
+ cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
+
+html: $(IMAGES) ${GRAPHS}
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml: $(IMAGES)
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml: $(IMAGES)
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle: $(IMAGES)
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json: $(IMAGES)
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp: $(IMAGES)
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp: $(IMAGES)
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc"
+
+devhelp: $(IMAGES)
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ns-3"
+ @echo "# devhelp"
+
+epub: $(IMAGES)
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex: $(IMAGES) ${GRAPHS}
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf: $(IMAGES) ${GRAPHS}
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text: $(IMAGES)
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man: $(IMAGES)
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes: $(IMAGES)
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck: $(IMAGEs)
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest: $(IMAGES)
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/rescale-pdf.sh Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+TMPFILE=`mktemp`
+
+echo "\documentclass{book}
+\usepackage{pdfpages}
+\begin{document}
+\includepdf[width=${1},fitpaper]{${2}}
+\end{document}" >${TMPFILE}.tex
+pdflatex -output-directory /tmp ${TMPFILE}.tex >/dev/null 2>/dev/null
+cp ${TMPFILE}.pdf ${3}
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/antenna-design.rst Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,98 @@
+.. include:: replace.txt
+
+
+++++++++++++++++++++++++++++++++++++++
+Design documentation
+++++++++++++++++++++++++++++++++++++++
+
+--------
+Overview
+--------
+
+The Antenna module provides:
+
+ #. a new base class (AntennaModel) that provides an interface for the modeling of the radiation pattern of an antenna;
+ #. a set of classes derived from this base class that each models the radiation pattern of different types of antennas.
+
+
+------------
+AntennaModel
+------------
+
+The AntennaModel uses the coordinate system adopted in [Balanis]_ and
+depicted in Figure :ref:`fig-antenna-coordinate-system`. This system
+is obtained by traslating the cartesian coordinate system used by the
+ns-3 MobilityModel into the new origin :math:`o` which is the location
+of the antenna, and then transforming the coordinates of every generic
+point :math:`p` of the space from cartesian coordinates
+:math:`(x,y,z)` into spherical coordinates
+:math:`(r, \theta,\phi)`.
+The antenna model neglects the radial component :math:`r`, and
+only considers the angle components :math:`(\theta, \phi)`. An antenna
+radiation pattern is then expressed as a mathematical function
+:math:`g(\theta, \phi) \longrightarrow \mathcal{R}` that returns the
+gain (in dB) for each possible direction of
+transmission/reception. All angles are expressed in radians.
+
+
+.. _fig-antenna-coordinate-system:
+
+.. figure:: figures/antenna-coordinate-system.*
+ :align: center
+
+ Coordinate system of the AntennaModel
+
+---------------
+Provided models
+---------------
+
+In this section we describe the antenna radiation pattern models that
+are included within the antenna module.
+
+
+IsotropicAntennaModel
++++++++++++++++++++++
+
+This antenna radiation pattern model provides a unitary gain (0 dB)
+for all direction.
+
+
+
+CosineAntennaModel
+++++++++++++++++++
+
+This is the cosine model described in [Chunjan]_: the antenna gain is
+determined as:
+
+.. math::
+
+ g(\phi, \theta) = \cos^{n} \left(\frac{\phi - \phi_{0}}{2} \right)
+
+where :math:`\phi_{0}` is the azimuthal orientation of the antenna
+(i.e., its direction of maximum gain) and the exponential
+
+.. math::
+
+ n = -\frac{3}{20 \log_{10} \left( \cos \frac{\phi_{3dB}}{4} \right)}
+
+determines the desired 3dB beamwidth :math:`\phi_{3dB}`.
+
+A major difference between the model of [Chunjian]_ and the one
+implemented in the class CosineAntennaModel is that only the element
+factor (i.e., what described by the above formulas) is considered. In
+fact, [Chunjian]_ also considered an additional antenna array
+factor. The reason why the latter is excluded is that we expect that
+the average user would desire to specify a given beamwidth exactly,
+without adding an array factor at a latter stage which would in
+practice alter the effective beamwidth of the resulting radiation
+pattern.
+
+
+References
+++++++++++
+
+.. [Balanis] C.A. Balanis, "Antenna Theory - Analysis and Design", Wiley, 2nd Ed.
+
+.. [Chunjian] Li Chunjian, "Efficient Antenna Patterns for
+ Three-Sector WCDMA Systems", Master of Science Thesis, Chalmers
+ University of Technology, Göteborg, Sweden, 2003
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/antenna-testing.rst Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,62 @@
++++++++++++++++++++++++++++++++++++++
+ Testing Documentation
++++++++++++++++++++++++++++++++++++++
+
+In this section we describe the test suites included with the antenna
+module that verify its correct functionality.
+
+
+Angles
+------
+
+The unit test suite ``angles`` verifies that the Angles class is
+constructed properly by correct conversion from 3D cartesian
+coordinates according to the available methods (construction from a
+single vector and from a pair of vectors). For each method, several
+test cases are provided that compare the values :math:`(\phi, \theta)`
+determied by the constructor to known reference values. The test
+passes if for each case the values are equal to the reference up to a
+tolerance of :math:`10^{-10}` which accounts for numerical errors.
+
+
+DegreesToRadians
+----------------
+
+The unit test suite ``degrees-radians`` verifies that the methods
+``DegreesToRadians`` and ``RadiansToDegrees`` work properly by
+comparing with known reference values in a number of test
+cases. Each test case passes if the comparison is equal up to a
+tolerance of :math:`10^{-10}` which accounts for numerical errors.
+
+
+
+IsotropicAntennaModel
+---------------------
+
+The unit test suite ``isotropic-antenna-model`` checks that the
+``IsotropicAntennaModel`` class works properly, i.e., returns always a
+0dB gain regardless of the direction.
+
+
+
+CosineAntennaModel
+------------------
+
+The unit test suite ``cosine-antenna-model`` checks that the
+``CosineAntennaModel`` class works properly. Several test cases are
+provided that check for the antenna gain value calculated at different
+directions and for different values of the orientation, the reference
+gain and the beamwidth. The reference gain is calculated by hand. Each
+test case passes if the reference gain in dB is equal to the value returned
+by ``CosineAntennaModel`` within a tolerance of 0.001, which accounts
+for the approximation done for the calculation of the reference
+values.
+
+
+
+
+
+
+
+
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/antenna-user.rst Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,16 @@
+.. include:: replace.txt
+
+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ User Documentation
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+The antenna moduled can be used with all the wireless technologies and
+physical layer models that support it. Currently, this includes
+the physical layer models based on the SpectrumPhy. Please refer to
+the documentation of each of these models for details.
+
+
+
+
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/antenna.rst Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,17 @@
+
+#####################################################
+Antenna Module
+#####################################################
+
+
+
+
+.. toctree::
+
+ antenna-design
+ antenna-user
+ antenna-testing
+
+
+
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/conf.py Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,215 @@
+# -*- coding: utf-8 -*-
+#
+# ns-3 documentation build configuration file, created by
+# sphinx-quickstart on Tue Dec 14 09:00:39 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.pngmath']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'LENA'
+copyright = u'2011-2012, CTTC'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = 'M2'
+# The full version, including alpha/beta/rc tags.
+release = 'M2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+#htmlhelp_basename = 'ns-3doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('antenna', 'antenna.tex', u'Antenna Module Documentation', u'Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'ns-3-model-library', u'ns-3 Model Library',
+ [u'ns-3 project'], 1)
+]
Binary file src/antenna/doc/source/figures/antenna-coordinate-system.dia has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/index.rst Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,17 @@
+
+#####################################################
+Antenna Module
+#####################################################
+
+
+
+
+.. toctree::
+
+ antenna-design
+ antenna-user
+ antenna-testing
+
+
+
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/antenna/doc/source/replace.txt Tue Jan 17 13:03:05 2012 +0100
@@ -0,0 +1,3 @@
+.. |ns3| replace:: *ns-3*
+
+.. |ns2| replace:: *ns-2*