Bound Class Reference

Defines a CAPS Bound Object. More...

Inherits object.

Inherited by capsBound.

Public Member Functions
	name (self)
	Property returns the name of the CAPS Bound Object.
	history (self)
	Returns the history list of the CAPS Analysis Object.
	close (self)
	Closes the bound indicating it's complete.
	markForDelete (self)
	Mark a CAPS Bound Object for deletion on the next Phase.
	info (self, printInfo=False, **kwargs)
	Gets information for the bound object.
	createTree (self, filename="boundName", **kwargs)
	Create a HTML dendrogram/tree of the current state of the bound.

Detailed Description

Defines a CAPS Bound Object.

Created via Problem.bound.create().

Parameters

Bound.vertexSet	VertexSetSequence of VertexSet instances
Bound.attr	AttrSequence of ValueIn attributes

Member Function Documentation

createTree()

createTree	(		self,
			filename = "boundName",
		**	kwargs
	)

Create a HTML dendrogram/tree of the current state of the bound.

The HTML file relies on the open-source JavaScript library, D3, to visualize the data. This library is freely available from https://d3js.org/ and is dynamically loaded within the HTML file. If running on a machine without internet access a (miniaturized) copy of the library may be written to a file alongside the generated HTML file by setting the internetAccess keyword to False. If set to True, internet access will be necessary to view the tree.

Parameters

filename	Filename to use when saving the tree (default - "boundName"). Note an ".html" is automatically appended to the name (same with ".json" if embedJSON = False).
**kwargs	See below.

Valid keywords:

Parameters

embedJSON	Embed the JSON tree data in the HTML file itself (default - True). If set to False a seperate file is generated for the JSON tree data.
internetAccess	Is internet access available (default True)? If set to True internet access will be necessary to view the tree.

info()

info	(		self,
			printInfo = False,
		**	kwargs
	)

Gets information for the bound object.

Parameters

printInfo	Print information to sceen if True.
**kwargs	See below.

Returns

State of bound object.

Valid keywords:

Parameters

infoDict

Return a dictionary containing bound information instead of just the state (default - False)

---

The documentation for this class was generated from the following file:

• pyCAPS/problem.py