Root object for all tangle objects. It's class-name (used for any type of code generation) is "tgl_obj".

The namespace within the parent namespace is "ph:tools:tangle".

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.

• All Objects -> C++ XML Objects -> @tglobj
  • filedef
  • enumfiledef

Here is a list of all uses of this object inside others. Click on the object to take you to the definition.

• Member "data" in filedef

Click here to see a tree representation of all objects.

Click here to return to the main index page.

Members

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.

description : stringtype

The description.

templates : templatevectortype

Template objects used to create others.

Methods

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.

• Abstract methods
  • get_block(block: stringtype): Pointer to @block
• Concrete methods
  • version(): tgl_versiontype
• Concrete methods (private)
  • version(): tgl_versiontype

get_block

Used by a parser to get a block.

Any other method of any other object can call this method. This is called 'public' access.

The data-type returned is "Pointer to @block"; The block that matches to name.

The method takes the following arguments:

block : stringtype

The name of the block.

Here is a list of all overrides of this method inside sub-classes. Click on the object to take you to the definition.