data_structures.Module_Use Class Reference

One use of a Module. More...

Inheritance diagram for data_structures.Module_Use:

Public Member Functions
def	__init__
	Module_Use constructor.
def	sub_node_insert
	Insert new_node into the module uses list for self at index
def	sub_node_delete
	Delete the index'th module use from self
def	xml_write
	Write XML of self to out_stream indented by indent.
Public Member Functions inherited from data_structures.Node
def	__init__
	Node Constructor
def	parent_index_find
	Recursively find parent of self starting from root_node.
def	show
	Method print self indented by indent.
def	sub_node_append
	Append sub_node to the children sub nodes of self.
def	xml_write
	Method writes self to out_stream indented by indent.

Detailed Description

One use of a Module.

This class represents one usage of a Module in a project. A project can contain multiple instances of the same kind of module.

Constructor & Destructor Documentation

def data_structures.Module_Use.__init__	(		self,
			name_vendor_module,
			module_uses,
			module_use_element,
			modules_table,
			style
	)

Module_Use constructor.

Parameters

self	Module_Use to initialize
name_vendor_module	None or tuple of (name, vendor, module)
module_uses	None or list of module uses
module_use_element	None or ET.Element to read XML from
modules_table	None or dict Table of Modules
style	Style object that specifies how to format generate code.

This method will initialize self from either name_vendor_module looked up from module_uses or extract the information from module_use_element

Member Function Documentation

def data_structures.Module_Use.sub_node_delete	(		self,
			index
	)

Delete the index'th module use from self

Parameters

self	"Module_Use* to modify
index	int Index slot of module use to delete

This method will delete the index'th module use from self

def data_structures.Module_Use.sub_node_insert	(		self,
			index,
			new_node
	)

Insert new_node into the module uses list for self at index

Parameters

self	Module_Use to modify
index	int location to insert new_node into
new_node	Node base class object to insert into self

This method will insert new_node into the module uses list of self at the index'th slot. new_node must be an object that uses Node as its base class.

def data_structures.Module_Use.xml_write	(		self,
			indent,
			out_stream
	)

Write XML of self to out_stream indented by indent.

Parameters

self	Module_Use to write out
indent	int The amount to indent it by
out_stream	File to write the XML out to

This method will write self in XML format to out_stream indented by indent.

Member Data Documentation

tuple data_structures.Module_Use.module_use

static

Initial value:

Module_Use(None, None,
          sub_module_use_element, modules_table, style)

---

The documentation for this class was generated from the following file:

• data_structures.py