GCodeAPI.GCodeCollector Class Reference

This is a g-code collection which help to manage IGCode objects. More...

Public Member Functions

 GCodeCollector ()
 Default constructor. More...
 
 GCodeCollector (int capacity)
 Constructs a new GCodeCollector and sets the capacity of its list. More...
 
 GCodeCollector (List< IGCode > code)
 Constructs a new GCodeCollector and sets its list. More...
 
void addCode (IGCode code)
 Appends the specified element to the end of this list. More...
 
void addCode (GCodeCollector codes)
 Appends all of the elements in the specified GCodeCollector to the end of this list. More...
 
override string ToString ()
 Returns to the g-code string of all elements. More...
 
void SaveTogCodeFile (string path)
 Saves the g-code strings as a text file. More...
 
GCodeCollector Duplicate ()
 Return a deep copy of the object. More...
 

Properties

List< IGCodeCodes [get]
 Gets the list of IGCode objects. More...
 
Point LastPoint [get]
 Returns the XY position of last GCodeLine object. More...
 

Detailed Description

This is a g-code collection which help to manage IGCode objects.

Constructor & Destructor Documentation

◆ GCodeCollector() [1/3]

GCodeAPI.GCodeCollector.GCodeCollector ( )

Default constructor.

◆ GCodeCollector() [2/3]

GCodeAPI.GCodeCollector.GCodeCollector ( int  capacity)

Constructs a new GCodeCollector and sets the capacity of its list.

Parameters
capacityThe number of elements that the new list can initially store.

◆ GCodeCollector() [3/3]

GCodeAPI.GCodeCollector.GCodeCollector ( List< IGCode code)

Constructs a new GCodeCollector and sets its list.

Parameters
codelist of IGCode objects

Member Function Documentation

◆ addCode() [1/2]

void GCodeAPI.GCodeCollector.addCode ( IGCode  code)

Appends the specified element to the end of this list.

Parameters
codeelement to be appended to this list

◆ addCode() [2/2]

void GCodeAPI.GCodeCollector.addCode ( GCodeCollector  codes)

Appends all of the elements in the specified GCodeCollector to the end of this list.

Parameters
codesGCodeCollector containing elements to be added to this list

◆ Duplicate()

GCodeCollector GCodeAPI.GCodeCollector.Duplicate ( )

Return a deep copy of the object.

Returns

◆ SaveTogCodeFile()

void GCodeAPI.GCodeCollector.SaveTogCodeFile ( string  path)

Saves the g-code strings as a text file.

Parameters
path

◆ ToString()

override string GCodeAPI.GCodeCollector.ToString ( )

Returns to the g-code string of all elements.

Returns

Property Documentation

◆ Codes

List<IGCode> GCodeAPI.GCodeCollector.Codes
get

Gets the list of IGCode objects.

◆ LastPoint

Point GCodeAPI.GCodeCollector.LastPoint
get

Returns the XY position of last GCodeLine object.


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