tincr::macros Namespace Reference

The macros ensemble encapsulates the macro class from Vivado's Tcl data structure. More...

Functions
	test args
	test_proc proc args
	new name
	delete macro
	add_cell macro cell rloc
	get args

Detailed Description

The macros ensemble encapsulates the macro class from Vivado's Tcl data structure.

Function Documentation

add_cell()

tincr::macros::add_cell			macro cell rloc

Add a cell to the macro.

Parameters

macro	The macro to update.
cell	The cell to add.
rloc	The relative location.

delete()

tincr::macros::delete			macro

Delete a macro.

Parameters

The	macro to delete.

get()

tincr::macros::get			args

Queries Vivado's object database for a list of macro objects that fit the given criteria. At the moment, this is just a wrapper function for Vivado's get_macros command.

new()

tincr::macros::new			name

Create a new macro.

Parameters

name	The name of the new macro.

Returns

The new macro object.

test()

tincr::macros::test			args

Executes all unit tests for every proc in the macros ensemble.

Parameters

args	The configuration arguments that will be passed to the tcltest unit testing suite.

test_proc()

tincr::macros::test_proc			proc args

Executes all unit tests for a particular proc in the macros ensemble.

Parameters

proc	The proc to run the unit tests for.
args	The configuration arguments that will be passed to the tcltest unit testing suite.