generate_launches_md.Launch_File Class Reference

List of all members.

Public Member Functions
def	__init__
def	section_write
def	show
def	summary_write
def	visit
Static Public Member Functions
def	file_parse
Public Attributes
	argument_comments
	conditionals
	includes
	macros
	name
	optionals
	requireds
	visited

---

Detailed Description

Definition at line 271 of file generate_launches_md.py.

---

Constructor & Destructor Documentation

def generate_launches_md.Launch_File.__init__	(		self,
			name,
			argument_comments,
			requireds,
			optionals,
			macros,
			includes,
			conditionals
	)

*Launch_File*: Initialize the *Launch_File* object (i.e. *self*)
    with *name*, *argument_comments*, *requireds*, *optionals*,
    *macros*, *includes*, and *conditionals*.

Definition at line 272 of file generate_launches_md.py.

---

Member Function Documentation

def generate_launches_md.Launch_File.file_parse	(		full_file_name,
			robot_bases
	)		[static]

*Launch_File*: Process one launch file.

Definition at line 299 of file generate_launches_md.py.

def generate_launches_md.Launch_File.section_write	(		self,
			md_file
	)

*Launch_File*: Write out the section for the *Launch_File* object
    (i.e. *self*) to *md_file*.

Definition at line 454 of file generate_launches_md.py.

def generate_launches_md.Launch_File.show

(

self

)

*Launch_File*: Print short contents of the *Launch_File* object
    (i.e. *self*).

Definition at line 507 of file generate_launches_md.py.

def generate_launches_md.Launch_File.summary_write	(		self,
			md_file
	)

*Launch_File*: Write out the summary item for the *Launch_File*
    object (i.e. *self*) to *md_file*:

Definition at line 517 of file generate_launches_md.py.

def generate_launches_md.Launch_File.visit	(		self,
			launch_files_table
	)

*Launch_File*: Recursively visit the *Launch_File* object
    (i.e. *self*) using *launch_files_table*.

Definition at line 537 of file generate_launches_md.py.

---

Member Data Documentation

generate_launches_md.Launch_File::argument_comments

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::conditionals

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::includes

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::macros

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::name

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::optionals

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::requireds

Definition at line 275 of file generate_launches_md.py.

generate_launches_md.Launch_File::visited

Definition at line 275 of file generate_launches_md.py.

---

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

• generate_launches_md.py