all CNC functions are encapsulated to cnc namespace More...

Classes
struct	SIMPLE_INFO
	Auxiliary G-code functions use this structure. More...

struct	P10DOUBLE
	This structure defines 10 coordinates of float64_t type (8 bytes) More...

struct	P10BOOL
	Structure similar to P10DOUBLE, using integers. More...

struct	ACTUAL_GM_VALUES
	Actual parameters. More...

struct	SIMPLE_GM_PARAMS_WIN32
	Describes one G-code part. More...

struct	CALLBACK_INFO
	Structure for transmitting information for the function ToolChainCore_GetLastError and for the callback functions AddOutputLogFunc, SetStatusBarTextFunc, MathWarningFunc. More...

struct	GCODE_FEED
	Definition of default feeds. More...

struct	AXIS_LIMITS
	Limits for one axis. More...

struct	GCODE_CORRECTION
	Definition of corrections. More...

struct	ARC_FEED_TABLE
	Table of speeds, relative arc speeds in relation to radius. More...

struct	INTERNAL_MFUNC_INSERT_TABLE
	Values of inserted M functions. More...

struct	GCODE_PARAMETERS
	Structure for setting G-code properties. More...

struct	GCODE_SIZE
	Initial position, end position and size. More...

struct	GCODE_INFO
	G-code size. More...

struct	DLL_INIT_STRUCT
	Initialization structure. Used by ToolChainCore_Init. More...

struct	MACHINE_PARAMETERS
	Machine parameters. More...

struct	MACHINE_STATUS
	Machine status. More...

struct	TGM_FUNCTION_INTERNAL
	base structure for activating a CNC function More...

struct	TGM_FUNCTION
	automatically sets the size of the structure to 8192 bytes More...

struct	TGM_CNC_CORE_MEMORY_INTERNAL
	shared CNC memory for one CNC core More...

struct	TGM_CNC_CORE_MEMORY
	automatically sets the size of the structure to 16384 bytes More...

struct	TGM_CNC_MEMORY_HEADER
	header of the shared TGM_CNCEX memory More...

struct	TGM_CNC_MEMORY
	describes the shared TGM_CNCEX memory More...

Typedefs
typedef int32_t	FuncPrototype(intptr_t dwUserData)
	Generic callback function prototype.

typedef int32_t	AddOutputLogFunc(intptr_t dwUserData, uint32_t tab, TGM_LPCTSTR info, CALLBACK_INFO *callBackInfo)
	Writes text to output log. More...

typedef int32_t	SetStatusBarTextFunc(intptr_t dwUserData, uint32_t pane, TGM_LPCTSTR strText, CALLBACK_INFO *callBackInfo)
	Display informational text in the status line of the application. More...

typedef int32_t	IsDebugModeFunc(intptr_t dwUserData)
	Ask if debug regime is enabled. More...

typedef int32_t	IsVerboseModeFunc(intptr_t dwUserData)
	Ask if verbose regime is enabled. More...

typedef TGM_LPCTSTR	GetLibPathFunc(intptr_t dwUserData)
	Returns path to external G functions stored as G-code on the disk. More...

typedef TGM_LPCTSTR	GetToolPathFunc(intptr_t dwUserData)
	Returns path to files describing tools geometry. Only for lathe. More...

typedef TGM_LPCTSTR	GetSystemPathFunc(intptr_t dwUserData)
	Returns path to system files. Not yet used by CNC module. More...

typedef int64_t	GetFileTimeStampFunc(intptr_t dwUserData, int32_t fileIdx)
	returns time stamp of a given file (usually time in ms since epoch) More...

typedef int32_t	DoYieldFunc(intptr_t dwUserData, int32_t messageOnly)
	Switch control to other thread. LOCAL_CORE_MODE_DLL only. More...

typedef void	ReadIniStringFunc(intptr_t dwUserData, TGM_LPCTSTR section, TGM_LPCTSTR key, TGM_LPCTSTR defValue, TGM_LPTSTR buffer, uint32_t bufferSizeInCharacters)
	Read string from .INI file. More...

typedef float64_t	ReadIniDoubleFunc(intptr_t dwUserData, TGM_LPCTSTR section, TGM_LPCTSTR key, float64_t defValue)
	Read float64_t value from .INI file. More...

typedef int32_t	ReadIniIntFunc(intptr_t dwUserData, TGM_LPCTSTR section, TGM_LPCTSTR key, int32_t defValue)
	Read integer value from .INI file. More...

typedef int32_t	IsBreakpointFunc(intptr_t dwUserData, uint32_t editorLine, int32_t fileIdx)
	Determines if there is a breakpoint on given G-code file line. More...

typedef int32_t	DispAndLocateErrorFunc(intptr_t dwUserData, uint32_t editorLine, int32_t fileIdx, TGM_LPCTSTR errString, CALLBACK_INFO *callBackInfo)
	This function is called in case of an error. More...

typedef void	DispRunInfoFunc(intptr_t dwUserData, const SIMPLE_GM_PARAMS_WIN32 *pCmd)

typedef int32_t	AddOutputLogWithMsgBoxFunc(intptr_t dwUserData, uint32_t tab, uint32_t buttons, TGM_LPCTSTR info, CALLBACK_INFO *callBackInfo)
	Writes text to output log and optionally displays it in message box dialog panel (OS dependent) More...

typedef int32_t	SetStatusBarProgressFunc(intptr_t dwUserData, uint32_t progress)
	Display progress bar. More...

typedef int32_t	DriverInitializeFunc(intptr_t dwUserData, float64_t *params, uint32_t nParams, cnc_status nRunMode)
	Called always before G-code execution. More...

typedef int32_t	DriverGFunc(intptr_t dwUserData, const SIMPLE_GM_PARAMS_WIN32 *v)
	Called to simulate G function. More...

typedef int32_t	DriverMFunc(intptr_t dwUserData, const SIMPLE_GM_PARAMS_WIN32 *v)
	Called to simulate M function. More...

typedef int32_t	ConnectPointCalcStartFunc(intptr_t dwUserData, const uint32_t nType, const uint32_t nCoords, const float64_t *coords, const uint32_t bitCodedAxesForCalc)
	Initiate user connection calculation. More...

typedef int32_t	ConnectPointCalcFunc(intptr_t dwUserData, const SIMPLE_GM_PARAMS_WIN32 part, float64_t calcSquareDistanceFromCoords, P10DOUBLE *calcConnectPoint)
	Calculate distance from initial tool point to a give G-code part. More...

typedef int32_t	ConnectPointCalcEndFunc(intptr_t dwUserData, SIMPLE_GM_PARAMS_WIN32 partToBeConnectedTo, P10DOUBLE connectPosToBeMovedTo)
	End of connection calculation. More...

typedef int32_t	DriverEnd(intptr_t dwUserData)
	Called when the G-code simulation finishes. More...

typedef int32_t	MathWarningFunc(intptr_t dwUserData, CALLBACK_INFO *pCallbackInfo)
	Called in case of warning issued during tool diameter compensation calculation. More...

Enumerations
enum class	cnc_status : int32_t { OFFLINE_M02 = -2 , INVALID_00 = 0 , COMPILING_01 = 1 , COMPILE_FINISHED_M01 = -1 , SIMULATING_10 = 10 , SIMULATION_END_M10 = -10 , SIMULATION_BREAK_M11 = -11 , TEST_20 = 20 , TEST_END_M20 = -20 , TEST_BREAK_M21 = -21 , TRAJECTORY_START_M30 = -30 , TRAJECTORY_BREAK_M31 = -31 , TRAJECTORY_END_M32 = -32 , TRAJECTORY_BREAK_M0_M33 = -33 , FORWARD_30 = 30 , FORWARD_NO_MFUNC_31 = 31 , BACKWARD_32 = 32 , FORWARD_SKIP_FIRST_M_33 = 33 , CONNECTING_40 = 40 , CONNECT_MOVE_41 = 41 , HAND_MOVE_50 = 50 , OUT_OF_TRAJECTORY_M50 = -50 , CALCULATING_60 = 60 , START_M_FUNCS_70 = 70 , STOP_M_FUNCS_80 = 80 , CONNECT_INS_M_FUNCS_90 = 90 , NONSENSE = -1234 }
	StatusCNC return codes. More...

enum class	connect_type : uint32_t { BY_COORD = 0 , BY_LINE_START = 1 , BY_LINE_END = 2 , BY_COORD_GO = 10 , BY_LINE_START_GO = 11 , BY_LINE_END_GO = 12 , BY_M_FUNC_COUNT = 20 , BY_M_FUNC_COUNT_REL = 21 , BY_GCODE_INDEX = 30 , BY_GCODE_INDEX_ACTUAL_COORD = 31 , BY_GCODE_INDEX_END = 32 , BY_COORD_GO_BUFFERED = 40 , BY_LINE_START_GO_BUFFERED = 41 , BY_LINE_END_GO_BUFFERED = 42 , BY_GCODE_INDEX_ACTUAL_COORD_GO_BUFFERED = 44 , BY_COORD_ON_TRAJECTORY_WITH_GCODE_INDEX_GO_BUFFERED = 46 }
	Connection modes (ToolChainCore_ConnectCNCEx_Plane) More...

enum class	status_after_connect : uint32_t { KEEP_00 = 0 , FORCE_OUT_OF_TRAJECTORY_02 = 2 }
	Specifies wanted status after successful connect for ToolChainCore_ConnectCNCEx_Plane. More...

enum class	axis_idx : int32_t { AXIS_NONE = -1 , AXIS_X = 0 , AXIS_Y = 1 , AXIS_Z = 2 , AXIS_C = 3 , AXIS_B = 4 , AXIS_U = 5 , AXIS_V = 6 , AXIS_W = 7 , AXIS_A = 8 , AXIS_O = 9 , AXIS_S = 100 , AXIS_T = 101 , AXIS_IO = 102 , AXIS_S2 = 103 , AXIS_XY = 200 }
	Axes numbers, together with special axis types. Assignment of the axes to array indexes is fixed, i.e. the first axis (index 0) is always X axis, etc... Special axes are used internally and have no relationship to array indexes. More...

enum class	reset_status_cnc : uint32_t { TO_INVALID_00 = 0 , TO_OUT_OF_TYRAJECTORY_01 = 1 }
	Values for ToolChainCore_ResetStatusCNC function. More...

enum class	cnc_func : uint32_t { NONE_00 = 0U , STOP_01 = 1U , START_02 = 2U , CONNECT_03 = 3U , GOTO_04 = 4U , SET_GCODE_PARAMETERS_05 = 5U , COMPILE_06 = 6U }
	CNC function to be activated from shared memory.

Functions
template<uint8_t c>
constexpr size_t	ADDR_IDX ()
	simplify G-code address indexing

Variables
constexpr uint32_t	COMM_DLL_VERSION { 511U }
	CNC and communication library (TGMmini_5.dll) version.

constexpr float64_t	INVALID_VALUE { 1e38 }
	this "nonsense" value is used for not used G-code addresses.

constexpr float32_t	INVALID_VALUE_F { 1e38F }
	this "nonsense" value is used for not used G-code addresses (float32_t version)

constexpr uint32_t	MAX_FUNC_ADDRESSES { TGM5_NAMESPACE :: MFUNC_NUMBER_PAR }
	number of letters in alphabet, i.e. all the G-code addresses

constexpr int32_t	TOOL_CHAIN_BAD_INTR_INDEX { -2 }
	ToolChainCore_XXX functions return codes. More...

constexpr int32_t	TOOL_CHAIN_ERROR { -1 }
	unknown error (pointer is null, invalid parameter value, etc...)

constexpr int32_t	TOOL_CHAIN_SUCCESS { 0 }
	OK value.

constexpr int32_t	TOOL_CHAIN_XEXEC { 1 }
	error during execution

constexpr int32_t	TOOL_CHAIN_XBREAK { 2 }
	execution has been interrupted

constexpr uint32_t	ACTUAL_N_AXES { TGM5_NAMESPACE :: MAX_INTERPOLATOR_AXES }
	number of axes used in CNC module (currently 10)

constexpr uint32_t	RESET_CNC_NO_G92 { 1U }
	Additional regimes for ToolChainCore_ResetCNC function. More...

constexpr uint32_t	NUMBER_OF_VARIABLES { 100U }
	Max number of user Pxx parameters.

constexpr uint32_t	SUB_PARS { 50U }
	Number of system parameters (P100 - P149)

constexpr uint32_t	MAX_DECLARED_PARAMS { NUMBER_OF_VARIABLES + SUB_PARS }
	Total number of parameters.

constexpr uint32_t	MAXLABELLENGTH { 40U }
	Max label length in the G-code (in characters)

constexpr int32_t	FILE_IDX_UNKNOWN { -1 }
	special file indexes More...

constexpr int32_t	FILE_IDX_END { -2 }
	end of G-code

constexpr int32_t	FILE_IDX_STOP { -3 }
	reserved

constexpr int32_t	FILE_IDX_EXEC { -4 }
	reserved

constexpr int32_t	FILE_IDX_INSERT_M_FUNCS { -5 }
	Start or Stop CNC additional M functions.

constexpr int32_t	FILE_IDX_INSERT_G_FUNCS { -6 }
	Move to connection point.

constexpr int32_t	FILE_IDX_RUNTIME_ERROR { -7 }
	reserved

constexpr int32_t	FILE_IDX_MOVE { -8 }
	GoTo position.

constexpr uint32_t	LOG_DEBUG_SWITCH { 0x00000001U }

constexpr uint32_t	LOG_VERBOSE_SWITCH { 0x00000002U }
	Produces more informational output to log and debug files.

constexpr uint32_t	LOG_WORKER { 0x00000004U }
	Enables logging of SF_XYZWorker_5 library messages.

constexpr uint32_t	LOG_TOOLCHAIN { 0x00000008U }
	Enables logging of SF_TCh_5 library messages.

constexpr uint32_t	LOG_DRIVER { 0x00000010U }
	Enables logging of SF_RTDrv_5 library messages.

constexpr uint32_t	LOG_COMPILER { 0x00000020U }
	Enables logging of SF_DComp_5 library messages.

constexpr uint32_t	LOG_EXEC { 0x00000040U }
	Enables logging of SF_DExec_5 library messages.

constexpr uint32_t	LOG_MATH { 0x00000080U }
	Enables logging of SF_XYZMath_5 library messages.

constexpr uint32_t	LOG_SEND_TO_DBGVIEW { 0x10000000U }

constexpr uint32_t	LOG_SEND_TO_FILE { 0x20000000U }

constexpr uint32_t	LOG_SEND_TO_TGM { 0x40000000U }

constexpr uint32_t	MAX_M_FUNC_IN_G { 4U }

constexpr uint32_t	PLANE_XY { 17 }
	CNC planes. More...

constexpr uint32_t	PLANE_XZ { 18 }
	G18.

constexpr uint32_t	PLANE_YZ { 19 }
	G19.

constexpr uint32_t	PLANE_ZX { 20 }
	G-18 - lathe only.

constexpr uint32_t	PLANE_XYZ { 21 }
	21 - general plane oriented in XYZ 3D space

constexpr uint32_t	CORR_STRATEGY_G41_ALREADY_CORRECTED { 0U }
	G41, G42 means already corrected coordinate; G40 says that only the end of the following motion will be left uncorrected.

constexpr uint32_t	CORR_STRATEGY_G41_STARTS_CORRECTION { 1U }
	G41, G42 only corrects the end of the following motion; G40 says the end of the previous motion will not be corrected.

constexpr uint32_t	CORR_STRATEGY_MASK { 0xFFU }
	bits not used for correction strategy

constexpr uint32_t	CORR_STRATEGY_OLD_VERSION { 0x80000000U }

constexpr uint32_t	CORR_STRATEGY_G00_WITHOUT_CORR { 0x40000000U }
	If this bit is set, G00 is always without correction.

constexpr uint32_t	CORR_STRATEGY_FORCE_TO_CONTINUE { 0x20000000U }

constexpr uint32_t	CORR_STRATEGY_CHECK_ORIGINAL_GCODE { 0x02000000U }
	checks continuity of the G-code with the given tolerance (see GCODE_PARAMETERS::tolerance).

constexpr uint32_t	CORR_STRATEGY_REMOVE_LAST_ARC { 0x01000000 }
	removes the last arc of a closed conture (in the case that the arc is the exit of the conture) if the equidistants do not cross

constexpr uint32_t	CORR_STRATEGY_REMOVE_FIRST_ARC { 0x00800000U }
	removes the first arc of a closed conture (in the case that the arc is the approach of the conture) if the equidistants do not cross

constexpr uint32_t	CORR_STRATEGY_NO_ADD_R { 0x00400000U }

constexpr uint32_t	CORR_STRATEGY_REMOVE_SMALL_ARCS { 0x00200000U }

constexpr uint32_t	CORR_STRATEGY_ALLOW_REVERSE_LINES { 0x00100000U }
	Allow more exact calculation of the tool compensation by reverse search with the buffer. Slows down the calculation.

constexpr uint32_t	CORR_STRATEGY_REMOVE_CROSSES { 0x00080000U }
	After the calculation, if there are crossed parts (which are not crossed in the original G-code), these parts are removed.

constexpr uint32_t	CORR_STRATEGY_CONNECT_WRONG_BY_G1 { 0x00040000U }
	After correction calculation, if there are unconnected parts, connect them by inserted G1.

constexpr uint32_t	CORR_STRATEGY_CONNECT_WRONG_BY_MOVE { 0x00020000U }

constexpr uint32_t	CORR_STRATEGY_ALLOW_FIRST_LAST_CROSS { 0x00010000U }
	Allow crossing of the first and last part of the closed conture. In that case, parts inside are not removed.

constexpr uint32_t	CORR_STRATEGY_SEARCH_MASK { 0x00000700U }
	mask bits for search deep number

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_10 { 0x00000100U }
	Search at least 10 parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_50 { 0x00000200U }
	Search at least 50 parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_100 { 0x00000300U }
	Search at least 100 parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_500 { 0x00000400U }
	Search at least 500 parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_1000 { 0x00000500U }
	Search at least 1000 parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_2000 { 0x00000600U }
	Search at least 2000 parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_SEARCH_DEEP_ALL { 0x00000700U }
	Search all parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_DEFAULT_DEEP { 1000U }
	Default deep search number. Search at least 1000 G-code parts for possible crosses.

constexpr uint32_t	CORR_STRATEGY_MIN_DEEP { 10U }
	Minimal search number.

constexpr uint32_t	F_BY_GCODE { 0U }
	Feed is fully defined in G-code.

constexpr uint32_t	F_BY_PARAMETERS { 1U }
	All feeds are set by values in `motion` array.

constexpr uint32_t	F_BY_PARAMETERS_FP_BY_GCODE { 2U }
	All feeds are set by values in `motion` array but can be overridden by FP address.

constexpr uint32_t	DEF_GCODE_FEED_G00 { 0U }
	indexes to feed table (GCODE_PARAMETERS::motion) More...

constexpr uint32_t	DEF_GCODE_FEED_G01 { 1U }
	linear interpolation G1

constexpr uint32_t	DEF_GCODE_FEED_REVERSE { 2U }
	backward movement (cnc_status::BACKWARD_32)

constexpr uint32_t	DEF_GCODE_FEED_CONNECT { 3U }
	connect to trajectory

constexpr uint32_t	DEF_GCODE_FEED_WITHOUT_M { 4U }
	movement without M functions

constexpr uint32_t	DEF_GCODE_FEED_GOTO_POSITION { 5U }
	goto position

constexpr uint32_t	DEF_GCODE_FEED_NORMAL_STOP { 6U }
	stop (only deceleration is used)

constexpr uint32_t	DEF_GCODE_FEED_EMERGENCY_STOP { 7U }
	emergency stop (only deceleration is used)

constexpr uint32_t	DISABLE_OPCODE_CALL { 0x00000001U }

constexpr uint32_t	DISABLE_ASSIGN_CALL { 0x00000002U }

constexpr uint32_t	DISABLE_REFRESH_ALL_PARAMS_CALL { 0x00000004U }

constexpr uint32_t	GCODE_ALLOWED_CIRC_CENTER_ACCURACY { 0U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_CROSSING_ACCURACY { 1U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_ANGULAR_PRECISION { 2U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_ANGULAR_DISTANCE_PRECISION { 3U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_MINIMAL_ALLOWED_ARC_R { 4U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_NO_ADD_R_MULTIPLIER { 5U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_SOURCE_PRECISION { 6U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	GCODE_MINIMAL_ALLOWED_LINE_LENGTH { 7U }
	index to GCODE_PARAMETERS::tolerance array

constexpr uint32_t	INTERPOLATOR_CONFIG0_USE_REL_SPEED_BY_TIME { 0x0000'0001 }

constexpr uint32_t	INTERPOLATOR_CONFIG0_CONT_M_FUNC_IN_PLACE { 0x0000'0002 }

constexpr uint32_t	INTERPOLATOR_CONFIG0_DO_NOT_STOP_BETWEEN_G00_G01 { 0x0001'0000 }

constexpr uint32_t	INTERPOLATOR_CONFIG0_USE_FAST_FEED_IN_ALL_REGIMES { 0x0002'0000 }

constexpr uint32_t	GCODE_SIZE_ORIGINAL_IDX { 0U }
	original G-code

constexpr uint32_t	GCODE_SIZE_CORRECTED_IDX { 1U }
	compensated G-code

constexpr uint32_t	GCODE_SIZE_ROTATED_IDX { 2U }
	original rotated G-code

constexpr uint32_t	GCODE_SIZE_ROTATED_CORRECTED_IDX { 3U }
	compensated rotated G-code

constexpr uint32_t	DEVICE_ERROR_OUT_TAB { 0U }
	add log message to specific log window if possible

constexpr uint32_t	CNC_OUT_TAB { 1U }
	add log message to specific log window if possible

constexpr uint32_t	M29_OUT_TAB { 2U }
	add log message to specific log window if possible

constexpr uint32_t	STATUS_LINE_ONLY { 3U }
	add log message to specific log window if possible

constexpr uint32_t	ACTIVATE_TAB { 0x100U }
	activate the selected tab

constexpr uint32_t	PREFIX_TIME { 0x200U }
	prefix the message with time

constexpr uint32_t	APP_AddOutputLogFunc { 1U }
	callback index number

constexpr uint32_t	APP_SetStatusBarTextFunc { 2U }
	callback index number

constexpr uint32_t	APP_IsDebugModeFunc { 3U }
	callback index number

constexpr uint32_t	APP_IsVerboseModeFunc { 4U }
	callback index number

constexpr uint32_t	APP_GetLibPathFunc { 5U }
	callback index number

constexpr uint32_t	APP_GetToolPathFunc { 6U }
	callback index number

constexpr uint32_t	APP_GetSystemPathFunc { 7U }
	callback index number

constexpr uint32_t	APP_GetFileTimeStampFunc { 10U }
	callback index number

constexpr uint32_t	APP_DoYieldFunc { 11U }
	callback index number

constexpr uint32_t	APP_ReadIniStringFunc { 12U }
	callback index number

constexpr uint32_t	APP_ReadIniDoubleFunc { 13U }
	callback index number

constexpr uint32_t	APP_ReadIniIntFunc { 14U }
	callback index number

constexpr uint32_t	APP_IsBreakpointFunc { 17U }
	callback index number

constexpr uint32_t	APP_DispAndLocateErrorFunc { 18U }
	callback index number

constexpr uint32_t	APP_DispRunInfo { 19U }

constexpr uint32_t	APP_SetStatusBarProgressFunc { 32U }
	callback index number

constexpr uint32_t	APP_MaxFuncNumber { 1000U }
	last function in APP group

constexpr uint32_t	DRV_InitializeFunc { 1001U }
	callback index number

constexpr uint32_t	DRV_GFunc { 1002U }
	callback index number

constexpr uint32_t	DRV_MFunc { 1003U }
	callback index number

constexpr uint32_t	ConnectPointCalcStartFuncNumber { 1004U }
	callback index number

constexpr uint32_t	ConnectPointCalcFunc_UseReturnValues { 1U }
	Return value of ConnectPointCalcFunc or ConnectPointCalcEndFunc values are used.

constexpr uint32_t	ConnectPointCalcFuncNumber { 1005U }
	callback index number

constexpr uint32_t	ConnectPointCalcEndFuncNumber { 1006U }
	callback index number

constexpr uint32_t	DRV_End { 1007U }
	callback index number

Detailed Description

all CNC functions are encapsulated to cnc namespace

Variable Documentation

◆ FILE_IDX_UNKNOWN

constexpr int32_t cnc::FILE_IDX_UNKNOWN { -1 }

constexpr

special file indexes

the file index cannot be identified

◆ LOG_DEBUG_SWITCH

constexpr uint32_t cnc::LOG_DEBUG_SWITCH { 0x00000001U }

constexpr

If this flag is set, helper diagnostics files are generated together with the G-code source file. Slows down the compilation and execution significantly.

◆ LOG_SEND_TO_DBGVIEW

constexpr uint32_t cnc::LOG_SEND_TO_DBGVIEW { 0x10000000U }

constexpr

The log is sent to the operating system standard debug output. Use DbgView on Windows or start the program from console on linux.

◆ LOG_SEND_TO_FILE

constexpr uint32_t cnc::LOG_SEND_TO_FILE { 0x20000000U }

constexpr

Log messages are sent to the log file. Usually it is located in the log subdirectory of the main program and file names are generated from date and time.

◆ LOG_SEND_TO_TGM

constexpr uint32_t cnc::LOG_SEND_TO_TGM { 0x40000000U }

constexpr

Log messages are sent to the TGMotion's debug subsystem and can be viewed by Control Observer's Debug Console window.

◆ MAX_M_FUNC_IN_G

constexpr uint32_t cnc::MAX_M_FUNC_IN_G { 4U }

constexpr

max number of M functions inside one G function
e.g. G1 X... Y... M3...
will be interpreted as

M3

G1 X... Y...

◆ PLANE_XY

constexpr uint32_t cnc::PLANE_XY { 17 }

constexpr

CNC planes.

G17

◆ RESET_CNC_NO_G92

constexpr uint32_t cnc::RESET_CNC_NO_G92 { 1U }

constexpr

Additional regimes for ToolChainCore_ResetCNC function.

do not change machine position

◆ TOOL_CHAIN_BAD_INTR_INDEX

constexpr int32_t cnc::TOOL_CHAIN_BAD_INTR_INDEX { -2 }

constexpr

ToolChainCore_XXX functions return codes.

invalid interpolator index

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Variable Documentation

◆ FILE_IDX_UNKNOWN

◆ LOG_DEBUG_SWITCH

◆ LOG_SEND_TO_DBGVIEW

◆ LOG_SEND_TO_FILE

◆ LOG_SEND_TO_TGM

◆ MAX_M_FUNC_IN_G

◆ PLANE_XY

◆ RESET_CNC_NO_G92

◆ TOOL_CHAIN_BAD_INTR_INDEX