tincr::nodes Namespace Reference

The noes ensemble encapsulates the node class from Vivado's Tcl data structure. More...

Functions
	test args
	get args
	get_source_wire args
	get_sinks args
	get_info node ?info?
	exist node
	hops node hops
	between_pips pip1 pip2
	manhattan_distance node

Detailed Description

The noes ensemble encapsulates the node class from Vivado's Tcl data structure.

Function Documentation

between_pips()

tincr::nodes::between_pips			pip1 pip2

Get the node that connects two PIPs.

Parameters

pip1	The first pip object.
pip2	The second pip object.

Returns

The node that connects these two PIPs, if any.

exist()

tincr::nodes::exist			node

Get whether or not a node actually exists. NOTE: This may be deprecated.

Parameters

node	The node object to query.

Returns

True (1) if the node exists, false (0) otherwise.

get_info()

tincr::nodes::get_info			node ?info?

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

Parameters

node	The node object or node name to query.
info	What information to get about the node. Valid values include "tile" or "name".

Returns

A string containing the specified information.

get_sinks()

tincr::nodes::get_sinks			args

Get a node's sink wires.

Parameters

The	node object.

Returns

A list of wire objects that are sourced by the node.

get_source_wire()

tincr::nodes::get_source_wire			args

Get a node's source wire.

Parameters

node	The node object to query.

Returns

The wire object that sources the node.

hops()

tincr::nodes::hops			node hops

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

Parameters

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

Returns

A list of node objects that are hops PIPs downhill from node.

manhattan_distance()

tincr::nodes::manhattan_distance			node

Get the Manhattan distance of a node.

Parameters

node	The node object.

Returns

An integer specifying the Mahattan distance of node in terms of tiles.