Page Comparison

...

Method	Usage
`append_directive`	Adds a directive to dictionary of directives `directives_by_scope`.
`consume_directive`	Called by parser whenever a directive is found during parsing of the TM1 rule file. Creates a new directive and appends it to the internal dictionary.
`resolve_directives`	Returns a new instance of `TM1DirectiveContainer` that has been added all applying directives according to region membership.
`apply_directives`	Resolves and applies directives to an area statement of a TM1 rule or feeder command.
`deregister`	Functionality was removed, originally served to store last splicing results in a file to be able to rollback to previous rule state.

TM1RegionContainer (class in TM1RegionContainer.py)

The class is used to store global list of regions defined throughout the TM1 rule file. Regions play important role when calculating scope of splicing directives to certain TM1 rule or feeder command.

The class defines following attributes:

Attribute	Type	Usage
`regions`	`Dict[str, TM1RegionStore]`	Dictionary of all available regions defined in the TM1 rule file indexed by region name. The value is `TM1RegionStore` object containing pointers to all instances of the region in the file.

The class exposes following methods:

Method	Usage
`add_region`	Adds a region to internal `regions` store.
`update_region_start`	Creates a new region and sets its start index (by characters counted from beginning of the file) according to parser.
`update_region_end`	Creates a new region and sets its end index or if the region already exists, updates its end index. Index is counted by number of characters from beginning of the file.
`get_regions`	Returns a list of regions that enclose specified string area by `start` and `end` indices if supplied. If not supplied, returns a list of all regions defined in the rule file. The list of regions is ordered by distance of the region start index to the string area.
`get_region`	Returns a list of all `TM1Region` instances based on supplied `region_name`.
`get_region_start`	Returns lowest available `start` index of all TM1Region instances based on supplied `region_name`.
`get_region_end`	Returns highest available `end` index of all TM1Region instances based on supplied `region_name`.

Versions Compared

Old Version 7

New Version 8

Key

TM1RegionContainer (class in TM1RegionContainer.py)