peano4.api.output.Output.Output Class Reference

Represents the total output generated from the Peano4 data model plus all the operations on it. More...

Inheritance diagram for peano4.api.output.Output.Output:

Collaboration diagram for peano4.api.output.Output.Output:

Public Member Functions
	__init__ (self)
	clear (self)
	The clear eliminates all artefacts, but it does not erase the Makefile.
	add (self, artefact, append=True)
	Add a new artefact.
	generate (self, overwrite, directory, subdirectories=[])
	Iterates over all stored artefacts and, hence, finally generates all the C files, makefiles, and so forth.

Data Fields
	artefacts
	readme
	makefile

Detailed Description

Represents the total output generated from the Peano4 data model plus all the operations on it.

This is basically a big collection.

Definition at line 7 of file Output.py.

Constructor & Destructor Documentation

__init__()

peano4.api.output.Output.Output.__init__

(

self

)

Definition at line 12 of file Output.py.

Member Function Documentation

add()

peano4.api.output.Output.Output.add	(		self,
			artefact,
			append = True
	)

Add a new artefact.

Once the project is generated, it will call generation() on the artefact. The artefact is either appended to the end of the list or prepended to the front of the list depending on the value of append.

Definition at line 29 of file Output.py.

References peano4.api.output.Output.Output.artefacts.

clear()

peano4.api.output.Output.Output.clear

(

self

)

The clear eliminates all artefacts, but it does not erase the Makefile.

This is important as I don't want to loose all the makefile info. If you want to clear the makefile, too, you have to invoke a clear on it.

Definition at line 18 of file Output.py.

References peano4.api.output.Output.Output.artefacts, peano4.api.output.Output.Output.makefile, and peano4.api.output.Output.Output.readme.

Referenced by peano4.api.output.Makefile.Makefile.__init__().

Here is the caller graph for this function:

generate()

peano4.api.output.Output.Output.generate	(		self,
			overwrite,
			directory,
			subdirectories = []
	)

Iterates over all stored artefacts and, hence, finally generates all the C files, makefiles, and so forth.

Definition at line 40 of file Output.py.

References peano4.api.output.Output.Output.artefacts, peano4.api.output.Output.Output.generate(), peano4.api.output.Output.Output.makefile, and peano4.api.output.Output.Output.readme.

Referenced by peano4.api.Project.Project.build(), and peano4.api.output.Output.Output.generate().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

artefacts

peano4.api.output.Output.Output.artefacts

Definition at line 13 of file Output.py.

Referenced by peano4.api.output.Output.Output.add(), peano4.api.output.Output.Output.clear(), and peano4.api.output.Output.Output.generate().

makefile

peano4.api.output.Output.Output.makefile

Definition at line 15 of file Output.py.

Referenced by peano4.api.output.Output.Output.clear(), and peano4.api.output.Output.Output.generate().

readme

peano4.api.output.Output.Output.readme

Definition at line 14 of file Output.py.

Referenced by peano4.api.output.Output.Output.clear(), and peano4.api.output.Output.Output.generate().

---

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

• src/peano4/api/output/Output.py