GCodeAPI.PetriTask Class Reference

This class represents a object which is prepared to print into a petri dish. More...

Public Member Functions

void Print (GCodeCollector code, double stagePositonX, double stagePositonY, double zOff)
 This function shifts to the equivalent position the codes of the object. More...
 
void Print (GCodeCollector code, Point stagePositon, double zOff)
 This function shifts to the equivalent position the codes of the object. More...
 
 PetriTask (string name)
 
 PetriTask (string name, string description)
 
 PetriTask (string name, string description, GCodeCollector mainCode)
 
override string ToString ()
 Returns the name of the object. More...
 
void Save (string path)
 Serializes the object into a binary file. More...
 
Stream GetStream ()
 Returns the memory stream of binarized object. More...
 

Static Public Member Functions

static PetriTask Load (string p)
 Opens a binarized object. More...
 

Properties

string Name [get, set]
 Name of object More...
 
string Description [get, set]
 Description of object More...
 
GCodeCollector Code [get, set]
 This is the main code collection. During the reposition process (Print functions) this code collection is centered also. More...
 

Detailed Description

This class represents a object which is prepared to print into a petri dish.

Member Function Documentation

◆ GetStream()

Stream GCodeAPI.PetriTask.GetStream ( )

Returns the memory stream of binarized object.

Returns

◆ Load()

static PetriTask GCodeAPI.PetriTask.Load ( string  p)
static

Opens a binarized object.

Parameters
pFile's path
Returns

◆ Print() [1/2]

void GCodeAPI.PetriTask.Print ( GCodeCollector  code,
double  stagePositonX,
double  stagePositonY,
double  zOff 
)

This function shifts to the equivalent position the codes of the object.

Parameters
codeInput code collection (byRef). The new codes are appended to this collection.
stagePositonXX positon of center of the printing area
stagePositonYY positon of center of the printing area
zOffz offset value

◆ Print() [2/2]

void GCodeAPI.PetriTask.Print ( GCodeCollector  code,
Point  stagePositon,
double  zOff 
)

This function shifts to the equivalent position the codes of the object.

Parameters
codeInput code collection (byRef). The new codes are appended to this collection.
stagePositonThe position of center of the printing area
zOffz offset value

◆ Save()

void GCodeAPI.PetriTask.Save ( string  path)

Serializes the object into a binary file.

Parameters
pathFile's path.

◆ ToString()

override string GCodeAPI.PetriTask.ToString ( )

Returns the name of the object.

Returns

Property Documentation

◆ Code

GCodeCollector GCodeAPI.PetriTask.Code
getset

This is the main code collection. During the reposition process (Print functions) this code collection is centered also.

◆ Description

string GCodeAPI.PetriTask.Description
getset

Description of object

◆ Name

string GCodeAPI.PetriTask.Name
getset

Name of object


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