tincr::pips Namespace Reference

The pips ensemble encapsulates the pip class from Vivado's Tcl data structure. More...

Functions
	test args
	get args
	get_info pip ?info?
	get_start args
	get_end args
	between_nodes node1 node2
	hops pip hops
	is_route_through pip

Detailed Description

The pips ensemble encapsulates the pip class from Vivado's Tcl data structure.

Function Documentation

between_nodes()

tincr::pips::between_nodes			node1 node2

Get the PIP that connects two nodes.

Parameters

node1	The first node object.
node2	The second node object.

Returns

The pip object that connects these two nodes, if any.

get_end()

tincr::pips::get_end			args

Get the sink node of a PIP.

Parameters

pip	The pip object.

Returns

The node object that is sourced by pip.

get_info()

tincr::pips::get_info			pip ?info?

Get information about a PIP that can be found by parsing its name.

Parameters

node	The pip object or PIP name to query.
info	What information to get about the PIP. Valid values include "tile", "type", "input", "direction", or "output".

Returns

A string containing the specified information.

get_start()

tincr::pips::get_start			args

Get the source node of a PIP.

Parameters

pip	The pip object.

Returns

The node object that sources pip.

hops()

tincr::pips::hops			pip hops

Get the set of PIPs that are some number of hops away from the given PIP. In this context, a "hop" refers the traversal of one node.

Parameters

pip	The pip object.
hops	An integer specifying the number of hops away from pip.

Returns

A list of pip objects that are hops nodes downhill from pip.

is_route_through()

tincr::pips::is_route_through			pip

Is this a route-through PIP?

Parameters

pip	The pip object.

Returns

True (1) if pip is a route-through PIP, false (0) otherwise.