polychemprint3.recipes.recipe module¶

Specifies modular recipe protocol to link series of sequences

First created on Mon May 11 17:27:00 2020
Revised:
Author: Bijal Patel

class polychemprint3.recipes.recipe.recipe(name: str = 'NoRecipeNameSet', description: str = 'NoRecipeDescriptionSet', dateCreated: str = 'NoDateSet', axes: <module 'polychemprint3.axes.axes3DSpec' from '/home/docs/checkouts/readthedocs.org/user_builds/polychemprint3/checkouts/latest/polychemprint3/axes/axes3DSpec.py'> = <polychemprint3.axes.nullAxes.nullAxes object>, tool: polychemprint3.tools.toolSpec.toolSpec = <polychemprint3.tools.nullTool.nullTool object>, seqList=None, __verbose__: bool = 0, **kwargs)¶

Bases: polychemprint3.utility.fileHandler.fileHandler, polychemprint3.utility.loggerSpec.loggerSpec

Class for recipes - a series of sequences joined together

addSeq(beforeIndex: int, newSeq: polychemprint3.sequence.sequenceSpec.sequenceSpec)¶: Adds a copy of the provided sequence to the seqList. :param beforeIndex: :type beforeIndex: int :param newSeq: :type newSeq: sequenceSpec

deleteSeq(index: int)¶: Adds a copy of the provided sequence to the seqList. :param index: :type index: int

genRecipe()¶

Loads print sequence into a list into cmdList attribute.

Returns:	whether successfully reached the end or not
Return type:	bool

loadLogSelf(logString)¶

loads log back into dict.

Parameters:	logString (String) – log string to be loaded back in

operateRecipe(axesIn, toolIn)¶: Performs print sequence. :returns: Whether recipe successfully completed or not :rtype: bool

reorderSeq(currentIndex: int, newIndex: int)¶: Moves sequence from currentIndex to newIndex in seqList. :param currentIndex: :type currentIndex: int :param newIndex: :type newIndex: int

writeLogSelf()¶

Generates log string containing dict to be written to log file.

Returns:	log in string format
Return type:	String

class polychemprint3.recipes.recipe.recipeStub(name: str = 'NoRecipeNameSet', description: str = 'NoRecipeDescriptionSet', dateCreated: str = 'NoDateSet', **kwargs)¶

Bases: polychemprint3.utility.fileHandler.fileHandler

Class for recipe stubs, just the name, description, path info