create-module Namespace Reference

Functions
def	create_argument_parser ()
def	create_file (path, template, **kwargs)
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)
def	make_wscript (moduledir, modname)

Variables
string	DOC_RST_TEMPLATE
string	EXAMPLE_CC_TEMPLATE
string	EXAMPLES_WSCRIPT_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
string	WSCRIPT_TEMPLATE

Function Documentation

create_argument_parser()

def create-module.create_argument_parser

(

)

Definition at line 436 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 322 of file create-module.py.

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

Here is the caller graph for this function:

make_doc()

def create-module.make_doc	(		moduledir,
			modname
	)

Definition at line 391 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 378 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 364 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 335 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 406 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 351 of file create-module.py.

References create_file().

Here is the call graph for this function:

make_wscript()

def create-module.make_wscript	(		moduledir,
			modname
	)

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

References create_file().

Here is the call graph for this function:

Variable Documentation

DOC_RST_TEMPLATE

string create-module.DOC_RST_TEMPLATE

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

EXAMPLE_CC_TEMPLATE

string create-module.EXAMPLE_CC_TEMPLATE

Initial value:

=  '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 
#include "ns3/core-module.h"
#include "ns3/{MODULE}-helper.h"
 
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 122 of file create-module.py.

EXAMPLES_WSCRIPT_TEMPLATE

string create-module.EXAMPLES_WSCRIPT_TEMPLATE

Initial value:

=  '''# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
 
def build(bld):
    obj = bld.create_ns3_program('{MODULE}-example', [{MODULE!r}])
    obj.source = '{MODULE}-example.cc'
 
'''

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

file

create-module.file

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

Referenced by ns3::Ns2MobilityHelper.Ns2MobilityHelper(), ns3::Hash::Example::DictFiles.Add(), PacketMetadataTest.CheckHistory(), ns3::Ns2MobilityHelper.ConfigNodesMovements(), ns3::PcapHelper.CreateFile(), ns3::PcapHelper.DefaultSink(), PacketTest.DoCheck(), PacketTest.DoCheckData(), ns3::WimaxHelper.EnablePcapInternal(), ns3::CsmaHelper.EnablePcapInternal(), ns3::FdNetDeviceHelper.EnablePcapInternal(), ns3::LrWpanHelper.EnablePcapInternal(), ns3::PointToPointHelper.EnablePcapInternal(), ns3::YansWavePhyHelper.EnablePcapInternal(), ns3::WifiPhyHelper.EnablePcapInternal(), ns3::InternetStackHelper.EnablePcapIpv4Internal(), ns3::InternetStackHelper.EnablePcapIpv6Internal(), BufferTest.EnsureWrittenBytes(), ns3::SystemPath.Exists(), ns3::AsciiTraceHelper.HookDefaultDequeueSinkWithoutContext(), ns3::AsciiTraceHelper.HookDefaultDropSinkWithoutContext(), ns3::AsciiTraceHelper.HookDefaultEnqueueSinkWithoutContext(), ns3::AsciiTraceHelper.HookDefaultReceiveSinkWithoutContext(), ns3::PcapHelper.HookDefaultSink(), ns3.Ipv4L3ProtocolRxTxSink(), ns3.Ipv6L3ProtocolRxTxSink(), ns3.PcapSniffLrWpan(), ns3::WifiPhyHelper.PcapSniffRxEvent(), ns3::WifiPhyHelper.PcapSniffTxEvent(), ns3.PcapSniffTxRxEvent(), PerfFile(), ns3::TestCase.ReportTestFailure(), RxDrop(), and ns3::PcapHelper.SinkWithHeader().

HELPER_CC_TEMPLATE

string create-module.HELPER_CC_TEMPLATE

Initial value:

=  '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 
#include "{MODULE}-helper.h"
 
namespace ns3 {{
 
/* ... */
 
 
}}
 
'''

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

HELPER_H_TEMPLATE

string create-module.HELPER_H_TEMPLATE

Initial value:

=  '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef {INCLUDE_GUARD}
#define {INCLUDE_GUARD}
 
#include "ns3/{MODULE}.h"
 
namespace ns3 {{
 
/* ... */
 
}}
 
#endif /* {INCLUDE_GUARD} */
 
'''

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

MODEL_CC_TEMPLATE

string create-module.MODEL_CC_TEMPLATE

Initial value:

=  '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 
#include "{MODULE}.h"
 
namespace ns3 {{
 
/* ... */
 
 
}}
 
'''

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

MODEL_H_TEMPLATE

string create-module.MODEL_H_TEMPLATE

Initial value:

=  '''/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef {INCLUDE_GUARD}
#define {INCLUDE_GUARD}
 
namespace ns3 {{
 
/* ... */
 
}}
 
#endif /* {INCLUDE_GUARD} */
 
'''

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

return_value

int create-module.return_value = 0

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

TEST_CC_TEMPLATE

string create-module.TEST_CC_TEMPLATE

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

WSCRIPT_TEMPLATE

string create-module.WSCRIPT_TEMPLATE

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