create-module Namespace Reference

Functions
	create_argument_parser ()
	create_file (path, template, **kwargs)
	make_cmakelists (moduledir, modname)
	make_doc (moduledir, modname)
	make_examples (moduledir, modname)
	make_helper (moduledir, modname)
	make_model (moduledir, modname)
	make_module (modpath, modname)
	make_test (moduledir, modname)

Variables
str	CMAKELISTS_TEMPLATE
str	DOC_RST_TEMPLATE
str	EXAMPLE_CC_TEMPLATE
str	EXAMPLES_CMAKELISTS_TEMPLATE
	file
str	HELPER_CC_TEMPLATE
str	HELPER_H_TEMPLATE
str	MODEL_CC_TEMPLATE
str	MODEL_H_TEMPLATE
int	return_value = 0
str	TEST_CC_TEMPLATE

Function Documentation

create_argument_parser()

create-module.create_argument_parser

(

)

Definition at line 451 of file create-module.py.

References create_argument_parser(), and make_module().

Referenced by create_argument_parser().

Here is the call graph for this function:

Here is the caller graph for this function:

create_file()

create-module.create_file	(		path,
			template,
		**	kwargs )

Definition at line 330 of file create-module.py.

Referenced by make_cmakelists(), make_doc(), make_examples(), make_helper(), make_model(), and make_test().

Here is the caller graph for this function:

make_cmakelists()

create-module.make_cmakelists	(		moduledir,
			modname )

Definition at line 338 of file create-module.py.

References create_file().

Here is the call graph for this function:

make_doc()

create-module.make_doc	(		moduledir,
			modname )

Definition at line 406 of file create-module.py.

References create_file().

Here is the call graph for this function:

make_examples()

create-module.make_examples	(		moduledir,
			modname )

Definition at line 393 of file create-module.py.

References create_file().

Here is the call graph for this function:

make_helper()

create-module.make_helper	(		moduledir,
			modname )

Definition at line 379 of file create-module.py.

References create_file().

Here is the call graph for this function:

make_model()

create-module.make_model	(		moduledir,
			modname )

Definition at line 346 of file create-module.py.

References create_file().

Here is the call graph for this function:

make_module()

create-module.make_module	(		modpath,
			modname )

Definition at line 421 of file create-module.py.

Referenced by create_argument_parser().

Here is the caller graph for this function:

make_test()

create-module.make_test	(		moduledir,
			modname )

Definition at line 360 of file create-module.py.

References create_file().

Here is the call graph for this function:

Variable Documentation

CMAKELISTS_TEMPLATE

str create-module.CMAKELISTS_TEMPLATE

Initial value:

=  """\
set(examples_as_tests_sources)
if(${{ENABLE_EXAMPLES}})
    set(examples_as_tests_sources
        #test/{MODULE}-examples-test-suite.cc
        )
endif()
 
build_lib(
    LIBNAME {MODULE}
    SOURCE_FILES model/{MODULE}.cc
                 helper/{MODULE}-helper.cc
    HEADER_FILES model/{MODULE}.h
                 helper/{MODULE}-helper.h
    LIBRARIES_TO_LINK ${{libcore}}
    TEST_SOURCES test/{MODULE}-test-suite.cc
                 ${{examples_as_tests_sources}}
)
"""

Definition at line 9 of file create-module.py.

DOC_RST_TEMPLATE

str create-module.DOC_RST_TEMPLATE

Definition at line 227 of file create-module.py.

EXAMPLE_CC_TEMPLATE

str create-module.EXAMPLE_CC_TEMPLATE

Initial value:

=  """\
#include "ns3/core-module.h"
#include "ns3/{MODULE}-helper.h"
 
/**
 * @file
 *
 * Explain here what the example does.
 */
 
using namespace ns3;
 
int
main(int argc, char* argv[])
{{
    bool verbose = true;
 
    CommandLine cmd(__FILE__);
    cmd.AddValue("verbose", "Tell application to log if true", verbose);
 
    cmd.Parse(argc, argv);
 
    /* ... */
 
    Simulator::Run();
    Simulator::Destroy();
    return 0;
}}
"""

Definition at line 106 of file create-module.py.

EXAMPLES_CMAKELISTS_TEMPLATE

str create-module.EXAMPLES_CMAKELISTS_TEMPLATE

Initial value:

=  """\
build_lib_example(
    NAME {MODULE}-example
    SOURCE_FILES {MODULE}-example.cc
    LIBRARIES_TO_LINK ${{lib{MODULE}}}
)
"""

Definition at line 98 of file create-module.py.

file

create-module.file

Definition at line 670 of file create-module.py.

HELPER_CC_TEMPLATE

str create-module.HELPER_CC_TEMPLATE

Initial value:

=  """\
#include "{MODULE}-helper.h"
 
namespace ns3
{{
 
/* ... */
 
}} // namespace ns3
"""

Definition at line 66 of file create-module.py.

HELPER_H_TEMPLATE

str create-module.HELPER_H_TEMPLATE

Initial value:

=  """\
#ifndef {INCLUDE_GUARD}
#define {INCLUDE_GUARD}
 
#include "ns3/{MODULE}.h"
 
namespace ns3
{{
 
// Each class should be documented using Doxygen,
// and have an @ingroup {MODULE} directive
 
/* ... */
 
}} // namespace ns3
 
#endif // {INCLUDE_GUARD}
"""

Definition at line 78 of file create-module.py.

MODEL_CC_TEMPLATE

str create-module.MODEL_CC_TEMPLATE

Initial value:

=  """\
#include "{MODULE}.h"
 
namespace ns3
{{
 
/* ... */
 
}} // namespace ns3
"""

Definition at line 30 of file create-module.py.

MODEL_H_TEMPLATE

str create-module.MODEL_H_TEMPLATE

Initial value:

=  """\
#ifndef {INCLUDE_GUARD}
#define {INCLUDE_GUARD}
 
// Add a doxygen group for this module.
// If you have more than one file, this should be in only one of them.
/**
 * @defgroup {MODULE} Description of the {MODULE}
 */
 
namespace ns3
{{
 
// Each class should be documented using Doxygen,
// and have an @ingroup {MODULE} directive
 
/* ... */
 
}} // namespace ns3
 
#endif // {INCLUDE_GUARD}
"""

Definition at line 42 of file create-module.py.

return_value

int create-module.return_value = 0

Definition at line 666 of file create-module.py.

TEST_CC_TEMPLATE

str create-module.TEST_CC_TEMPLATE

Definition at line 137 of file create-module.py.