| filedef |
Class used to represent the definition of a file (like a header or implementation) for the tangle tool. It's class-name (used for any type of code generation) is "tgl_filedef".
The object fits into the tree of objects in the following way. Click on other objects in to navigate to that object. Objects to the left of this object are superclasses, and objects listed below it derive from this one.
Here is a list of all uses of this object inside others. Click on the object to take you to the definition.
Click here to see a tree representation of all objects.
Click here to return to the main index page.
This object contains members which hold data for the object. Following is a list of those members. The declaration of the member closely follows the UML conventions.
filepath : pathtype
The path to use for the file. This would be a folder when the file definition is used on multiple objects, and the actual output filename when used as a one off.
extension : stringtype
The extension to use for the file. This is appended to the object name when multiple objects are processed through this filedef.
root : stringtype
The location of the root to use for the filedef if the objname passed in is "*".
data : Typed object vector of @tglobj
Generic data that may be used later.
blocks : Typed object vector of @block
The blocks to be placed in the file.
structure : stringtype
the overall structure of the file.
ignoreobjects : stringtype
A list of objects which should be ignored in the schema.
stream : streamptrtype
The real output stream.
console : streamptrtype
The real console stream.
This object contains methods which can be called from other objects. Following is a list of those methods. The syntax of the method, it's arguments and return value follow closely the UML conventions.