A Discrete-Event Network Simulator
API
create-module Namespace Reference

Functions

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

Variables

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

Function Documentation

◆ create_argument_parser()

def create-module.create_argument_parser ( )

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

References make_module().

+ Here is the call graph for this function:

◆ create_file()

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

Definition at line 320 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()

def create-module.make_cmakelists (   moduledir,
  modname 
)

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

References create_file().

+ Here is the call graph for this function:

◆ make_doc()

def create-module.make_doc (   moduledir,
  modname 
)

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

References create_file().

+ Here is the call graph for this function:

◆ make_examples()

def create-module.make_examples (   moduledir,
  modname 
)

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

References create_file().

+ Here is the call graph for this function:

◆ make_helper()

def create-module.make_helper (   moduledir,
  modname 
)

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

References create_file().

+ Here is the call graph for this function:

◆ make_model()

def create-module.make_model (   moduledir,
  modname 
)

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

References create_file().

+ Here is the call graph for this function:

◆ make_module()

def create-module.make_module (   modpath,
  modname 
)

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

Referenced by create_argument_parser().

+ Here is the caller graph for this function:

◆ make_test()

def create-module.make_test (   moduledir,
  modname 
)

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

References create_file().

+ Here is the call graph for this function:

Variable Documentation

◆ CMAKELISTS_TEMPLATE

string create-module.CMAKELISTS_TEMPLATE

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

◆ DOC_RST_TEMPLATE

string create-module.DOC_RST_TEMPLATE

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

◆ EXAMPLE_CC_TEMPLATE

string create-module.EXAMPLE_CC_TEMPLATE
Initial value:
1 = '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 
3 #include "ns3/core-module.h"
4 #include "ns3/{MODULE}-helper.h"
5 
6 using namespace ns3;
7 
8 
9 int
10 main (int argc, char *argv[])
11 {{
12  bool verbose = true;
13 
14  CommandLine cmd (__FILE__);
15  cmd.AddValue ("verbose", "Tell application to log if true", verbose);
16 
17  cmd.Parse (argc,argv);
18 
19  /* ... */
20 
21  Simulator::Run ();
22  Simulator::Destroy ();
23  return 0;
24 }}
25 
26 
27 '''

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

◆ EXAMPLES_CMAKELISTS_TEMPLATE

string create-module.EXAMPLES_CMAKELISTS_TEMPLATE
Initial value:
1 = '''\
2 set(name {MODULE}-example)
3 set(source_files ${{name}}.cc)
4 set(header_files)
5 set(libraries_to_link ${{lib{MODULE}}})
6 {BUILD_EXAMPLE_MACRO}("${{name}}" "${{source_files}}" "${{header_files}}" "${{libraries_to_link}}")
7 
8 '''

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

◆ file

◆ HELPER_CC_TEMPLATE

string create-module.HELPER_CC_TEMPLATE
Initial value:
1 = '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 
3 #include "{MODULE}-helper.h"
4 
5 namespace ns3 {{
6 
7 /* ... */
8 
9 
10 }}
11 
12 '''

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

◆ HELPER_H_TEMPLATE

string create-module.HELPER_H_TEMPLATE
Initial value:
1 = '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 #ifndef {INCLUDE_GUARD}
3 #define {INCLUDE_GUARD}
4 
5 #include "ns3/{MODULE}.h"
6 
7 namespace ns3 {{
8 
9 /* ... */
10 
11 }}
12 
13 #endif /* {INCLUDE_GUARD} */
14 
15 '''

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

◆ MODEL_CC_TEMPLATE

string create-module.MODEL_CC_TEMPLATE
Initial value:
1 = '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 
3 #include "{MODULE}.h"
4 
5 namespace ns3 {{
6 
7 /* ... */
8 
9 
10 }}
11 
12 '''

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

◆ MODEL_H_TEMPLATE

string create-module.MODEL_H_TEMPLATE
Initial value:
1 = '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 #ifndef {INCLUDE_GUARD}
3 #define {INCLUDE_GUARD}
4 
5 namespace ns3 {{
6 
7 /* ... */
8 
9 }}
10 
11 #endif /* {INCLUDE_GUARD} */
12 
13 '''

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

◆ return_value

int create-module.return_value = 0

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

◆ TEST_CC_TEMPLATE

string create-module.TEST_CC_TEMPLATE

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