Class MachineConfigurationHelper

Helper methods for ICamApiMachineConfiguration

Inheritance

object

MachineConfigurationHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class MachineConfigurationHelper

Methods

AxesCount(ComWrapper<ICamApiMachineConfiguration>)

Count of axes in machine configuration

Declaration

public static int AxesCount(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration

Returns

Type	Description
int

AxisAvailable(ComWrapper<ICamApiMachineConfiguration>, int)

Get whether axis is available in machine configuration

Declaration

public static bool AxisAvailable(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Axis index

Returns

Type	Description
bool

AxisDefined(ComWrapper<ICamApiMachineConfiguration>, int)

Get whether axis value is defined in machine configuration

Declaration

public static bool AxisDefined(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Axis index

Returns

Type	Description
bool

AxisId(ComWrapper<ICamApiMachineConfiguration>, int)

Get axis ID by index (0..AxesCount-1)

Declaration

public static string AxisId(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Axis index

Returns

Type	Description
string

AxisValue(ComWrapper<ICamApiMachineConfiguration>, int)

Get axis value in machine configuration

Declaration

public static double AxisValue(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Axis index

Returns

Type	Description
double

FlipCaption(ComWrapper<ICamApiMachineConfiguration>, int)

Get flip caption (depends on localization) by index (0..FlipsCount-1)

Declaration

public static string FlipCaption(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Flip index

Returns

Type	Description
string

FlipEnabled(ComWrapper<ICamApiMachineConfiguration>, int)

Get whether flip is enabled in machine configuration

Declaration

public static bool FlipEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Flip index

Returns

Type	Description
bool

FlipId(ComWrapper<ICamApiMachineConfiguration>, int)

Get flip ID by index (0..FlipsCount-1)

Declaration

public static string FlipId(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Flip index

Returns

Type	Description
string

FlipsCount(ComWrapper<ICamApiMachineConfiguration>)

Count of flips in machine configuration

Declaration

public static int FlipsCount(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration

Returns

Type	Description
int

GetAxisIndexOf(ComWrapper<ICamApiMachineConfiguration>, string)

Get index of axis by its ID (or -1 if axis with such ID is not in configuration)

Declaration

public static int GetAxisIndexOf(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, string axisId)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
string	axisId	Axis ID

Returns

Type	Description
int

SetAxesValues(ComWrapper<ICamApiMachineConfiguration>, ComWrapper<ICamApiMachineEvaluator>, bool)

Set all axes values according to current position of machine evaluator

Declaration

public static void SetAxesValues(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, ComWrapper<ICamApiMachineEvaluator> machineEvaluator, bool rotaryAxesOnly)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
ComWrapper<ICamApiMachineEvaluator>	machineEvaluator	Machine evaluator
bool	rotaryAxesOnly	True if only rotary axes should be set

SetAxisDefined(ComWrapper<ICamApiMachineConfiguration>, int, bool)

Set whether axis value is defined in machine configuration

Declaration

public static void SetAxisDefined(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Axis index
bool	value	True to mark axis as defined

SetAxisValue(ComWrapper<ICamApiMachineConfiguration>, int, double)

Set axis value in machine configuration

Declaration

public static void SetAxisValue(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Axis index
double	value	Axis value

SetFlipEnabled(ComWrapper<ICamApiMachineConfiguration>, int, bool)

Set whether flip is enabled in machine configuration

Declaration

public static void SetFlipEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiMachineConfiguration>	machineConfigurationCom	Machine configuration
int	index	Flip index
bool	value	True to enable flip