Class MachineAxisIndexes

Class containing machine axis indexes. Provides mapping between axis name and its index in the control system.

Inheritance

object

MachineAxisIndexes

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: DotNet.Interpreter.Helper

Assembly: DotNet.Interpreter.Helper.dll

Syntax

public class MachineAxisIndexes

Remarks

Initializes a new instance of the MachineAxisIndexes class.

Constructors

MachineAxisIndexes(INCT_Kernel2, INCT_Equipment, INCT_SysState)

Class containing machine axis indexes. Provides mapping between axis name and its index in the control system.

Declaration

public MachineAxisIndexes(INCT_Kernel2 kernel, INCT_Equipment equipment, INCT_SysState systemState)

Parameters

Type	Name	Description
INCT_Kernel2	kernel	System kernel interface.
INCT_Equipment	equipment	Interface for equipment interaction and obtaining axis information.
INCT_SysState	systemState	Interface for accessing system state.

Remarks

Initializes a new instance of the MachineAxisIndexes class.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

Properties

GetAxis

Gets the dictionary containing the mapping between axis name and its index.

Declaration

public Dictionary<string, int> GetAxis { get; }

Property Value

Type	Description
Dictionary<string, int>

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

XAxis

Gets the index of the X axis in the machine coordinate system.

Declaration

public int XAxis { get; }

Property Value

Type	Description
int	The index of the X axis, or -1 if the axis is not found in the machine configuration.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

YAxis

Gets the index of the Y axis in the machine coordinate system.

Declaration

public int YAxis { get; }

Property Value

Type	Description
int	The index of the Y axis, or -1 if the axis is not found in the machine configuration.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

ZAxis

Gets the index of the Z axis in the machine coordinate system.

Declaration

public int ZAxis { get; }

Property Value

Type	Description
int	The index of the Z axis, or -1 if the axis is not found in the machine configuration.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

Methods

~MachineAxisIndexes()

Destructor of the MachineAxisIndexes class. Releases resources.

Declaration

protected ~MachineAxisIndexes()

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

GetAxisByRegister(string)

Gets the axis index by its name.

Declaration

public int GetAxisByRegister(string axisName)

Parameters

Type	Name	Description
string	axisName	Axis name.

Returns

Type	Description
int	Axis index or -1 if the axis is not found.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

InitializeAxes(RegisterManager)

Initializes axis indexes based on system registers (for milling machines). Maps register names to axis indexes from equipment configuration.

Declaration

public void InitializeAxes(RegisterManager registers)

Parameters

Type	Name	Description
RegisterManager	registers	Collection of system registers.

Exceptions

Type	Condition
ArgumentNullException	Thrown if registers is null.

InitializeAxes(RegisterManager, CurrentOperationAxisIndex[])

Initializes axis indexes based on system registers and current operation information (for turning-milling machines). Takes into account the correspondence of axis identifiers to their ordinal numbers in the current operation.

Declaration

public void InitializeAxes(RegisterManager registers, CurrentOperationAxisIndex[] currentOperationAxisIndices)

Parameters

Type	Name	Description
RegisterManager	registers	Collection of system registers.
CurrentOperationAxisIndex[]	currentOperationAxisIndices	Array of axis indexes for the current operation.

Exceptions

Type	Condition
ArgumentNullException	Thrown if registers or currentOperationAxisIndices is null.

InitializeLinearMotionFormerAxis(INCT_LinearMotionFormer)

Initializes linear axis indexes in the toolpath former.

Declaration

public void InitializeLinearMotionFormerAxis(INCT_LinearMotionFormer linearMotionFormer)

Parameters

Type	Name	Description
INCT_LinearMotionFormer	linearMotionFormer	Linear motion former interface.

Exceptions

Type	Condition
ArgumentNullException	Thrown if linearMotionFormer is null.

InitializeLinearMotionFormerSpindleAxis(INCT_LinearMotionFormer)

Initializes spindle axis indexes in the toolpath former.

Declaration

public void InitializeLinearMotionFormerSpindleAxis(INCT_LinearMotionFormer linearMotionFormer)

Parameters

Type	Name	Description
INCT_LinearMotionFormer	linearMotionFormer	Linear motion former interface.

Exceptions

Type	Condition
ArgumentNullException	Thrown if linearMotionFormer is null.

IsCorrectAxis(string, out int)

Checks if an axis with the specified name exists in the machine configuration and returns its index. If the axis is not found, displays a warning (once for each axis name).

Declaration

public bool IsCorrectAxis(string axisName, out int axisIndex)

Parameters

Type	Name	Description
string	axisName	Axis name.
int	axisIndex	Variable to return the axis index. Returns -1 if the axis is not found.

Returns

Type	Description
bool	True if the axis is found, otherwise - false.

Exceptions

Type	Condition
ArgumentNullException	Thrown if axisName is null.