PathScripts.PathToolLibraryManager.ToolLibraryManager Class Reference

Public Member Functions
def	addnew (self, listname, tool, position=None)
def	addNewToolTable (self)
def	delete (self, number, listname)
def	deleteToolTable (self)
def	duplicate (self, number, listname)
def	getCurrentTable (self)
def	getCurrentTableName (self)
def	getJobList (self)
def	getNextToolTableName (self, tableName='Tool Table')
def	getTableFromName (self, name)
def	getTool (self, listname, toolnum)
def	getTools (self, tablename)
def	getToolTables (self)
def	loadToolTables (self)
def	movedown (self, number, listname)
def	moveToTable (self, number, listname)
def	moveup (self, number, listname)
def	read (self, filename, listname)
def	renameToolTable (self, newName, index)
def	saveMainLibrary (self)
def	templateAttrs (self)
def	tooltableFromAttrs (self, stringattrs)
def	updateTool (self, listname, toolnum, tool)
def	write (self, filename, listname)

Public Attributes
	currentTableName
	prefs
	toolTables

Static Public Attributes
	PreferenceMainLibraryJSON
	PreferenceMainLibraryXML
	TooltableTypeHeekscad
	TooltableTypeJSON
	TooltableTypeLinuxCNC
	TooltableTypeXML

Detailed Description

The Tool Library is a list of individual tool tables.  Each
Tool Table can contain n tools.  The tool library will be persisted to user
preferences and all or part of the library can be exported to other formats

Member Function Documentation

addnew()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.addnew	(		self,
			listname,
			tool,
			position = None
	)

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

addNewToolTable()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.addNewToolTable

(

self

)

creates a new tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getNextToolTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

delete()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.delete	(		self,
			number,
			listname
	)

deletes a tool from the current list

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

deleteToolTable()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.deleteToolTable

(

self

)

deletes the selected tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.currentTableName, PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

duplicate()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.duplicate	(		self,
			number,
			listname
	)

duplicates the selected tool in the selected tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

getCurrentTable()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTable

(

self

)

returns an object of the current tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.currentTableName, and PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName().

getCurrentTableName()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName

(

self

)

return the name of the currently loaded tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.currentTableName.

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.addnew(), PathScripts.PathToolLibraryManager.ToolLibraryManager.delete(), PathScripts.PathToolLibraryManager.ToolLibraryManager.duplicate(), PathScripts.PathToolLibraryManager.ToolLibraryManager.movedown(), PathScripts.PathToolLibraryManager.ToolLibraryManager.moveToTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.moveup(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.updateTool().

getJobList()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getJobList

(

self

)

Builds the list of all Tool Table lists

getNextToolTableName()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getNextToolTableName	(		self,
			tableName = 'Tool Table'
	)

get a unique name for a new tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.addNewToolTable(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.tooltableFromAttrs().

getTableFromName()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName	(		self,
			name
	)

get the tool table object from the name 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.addnew(), PathScripts.PathToolLibraryManager.ToolLibraryManager.delete(), PathScripts.PathToolLibraryManager.ToolLibraryManager.duplicate(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTool(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTools(), PathScripts.PathToolLibraryManager.ToolLibraryManager.movedown(), PathScripts.PathToolLibraryManager.ToolLibraryManager.moveToTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.moveup(), PathScripts.PathToolLibraryManager.ToolLibraryManager.renameToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.updateTool(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.write().

getTool()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getTool	(		self,
			listname,
			toolnum
	)

gets the tool object 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName().

getTools()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getTools	(		self,
			tablename
	)

returns the tool data for a given table

References PathScripts.PathToolLibraryManager.ToolLibraryManager.currentTableName, PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

getToolTables()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.getToolTables

(

self

)

Return tool table list 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

loadToolTables()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables

(

self

)

loads the tool tables from the stored data 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.currentTableName, PathScripts.PathToolLibraryManager.ToolLibraryManager.PreferenceMainLibraryJSON, PathScripts.PathToolLibraryManager.ToolLibraryManager.prefs, PathScripts.PathToolLibraryManager.ToolLibraryManager.tooltableFromAttrs(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

movedown()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.movedown	(		self,
			number,
			listname
	)

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

moveToTable()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.moveToTable	(		self,
			number,
			listname
	)

Moves the tool to selected tool table 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName().

moveup()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.moveup	(		self,
			number,
			listname
	)

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

read()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.read	(		self,
			filename,
			listname
	)

References PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary(), PathScripts.PathToolLibraryManager.ToolLibraryManager.tooltableFromAttrs(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

renameToolTable()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.renameToolTable	(		self,
			newName,
			index
	)

renames a tool table with the new name

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

saveMainLibrary()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary

(

self

)

Persists the permanent library to FreeCAD user preferences

References PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables(), PathScripts.PathToolLibraryEditor.EditorPanel.loadToolTables(), PathScripts.PathToolLibraryManager.ToolLibraryManager.PreferenceMainLibraryJSON, PathScripts.PathToolLibraryManager.ToolLibraryManager.prefs, PathScripts.PathToolController.ToolController.templateAttrs(), PathScripts.PathToolLibraryManager.ToolLibraryManager.templateAttrs(), PathScripts.PathToolBit.ToolBit.templateAttrs(), and PathScripts.PathJob.ObjectJob.templateAttrs().

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.addnew(), PathScripts.PathToolLibraryManager.ToolLibraryManager.addNewToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.delete(), PathScripts.PathToolLibraryManager.ToolLibraryManager.deleteToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.duplicate(), PathScripts.PathToolLibraryManager.ToolLibraryManager.movedown(), PathScripts.PathToolLibraryManager.ToolLibraryManager.moveup(), PathScripts.PathToolLibraryManager.ToolLibraryManager.read(), PathScripts.PathToolLibraryManager.ToolLibraryManager.renameToolTable(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.updateTool().

templateAttrs()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.templateAttrs

(

self

)

gets the tool table arributes 

References PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.write().

tooltableFromAttrs()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.tooltableFromAttrs	(		self,
			stringattrs
	)

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getNextToolTableName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables.

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.read().

updateTool()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.updateTool	(		self,
			listname,
			toolnum,
			tool
	)

updates tool data

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

write()

def PathScripts.PathToolLibraryManager.ToolLibraryManager.write	(		self,
			filename,
			listname
	)

References PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), PathScripts.PathToolController.ToolController.templateAttrs(), PathScripts.PathToolLibraryManager.ToolLibraryManager.templateAttrs(), PathScripts.PathToolBit.ToolBit.templateAttrs(), PathScripts.PathJob.ObjectJob.templateAttrs(), PathScripts.PathToolLibraryManager.ToolLibraryManager.TooltableTypeLinuxCNC, and PathScripts.PathToolLibraryManager.ToolLibraryManager.TooltableTypeXML.

Member Data Documentation

currentTableName

PathScripts.PathToolLibraryManager.ToolLibraryManager.currentTableName

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.deleteToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getCurrentTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTools(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables().

PreferenceMainLibraryJSON

PathScripts.PathToolLibraryManager.ToolLibraryManager.PreferenceMainLibraryJSON

static

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

PreferenceMainLibraryXML

PathScripts.PathToolLibraryManager.ToolLibraryManager.PreferenceMainLibraryXML

static

prefs

PathScripts.PathToolLibraryManager.ToolLibraryManager.prefs

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary().

toolTables

PathScripts.PathToolLibraryManager.ToolLibraryManager.toolTables

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.addNewToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.deleteToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getNextToolTableName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTableFromName(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getTools(), PathScripts.PathToolLibraryManager.ToolLibraryManager.getToolTables(), PathScripts.PathToolLibraryManager.ToolLibraryManager.loadToolTables(), PathScripts.PathToolLibraryManager.ToolLibraryManager.read(), PathScripts.PathToolLibraryManager.ToolLibraryManager.renameToolTable(), PathScripts.PathToolLibraryManager.ToolLibraryManager.templateAttrs(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.tooltableFromAttrs().

TooltableTypeHeekscad

PathScripts.PathToolLibraryManager.ToolLibraryManager.TooltableTypeHeekscad

static

TooltableTypeJSON

PathScripts.PathToolLibraryManager.ToolLibraryManager.TooltableTypeJSON

static

TooltableTypeLinuxCNC

PathScripts.PathToolLibraryManager.ToolLibraryManager.TooltableTypeLinuxCNC

static

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.write().

TooltableTypeXML

PathScripts.PathToolLibraryManager.ToolLibraryManager.TooltableTypeXML

static

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.write().

---

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

• src/Mod/Path/PathScripts/PathToolLibraryManager.py