Class MachineConfigurationHelper

Helper methods for ICamApiMachineConfiguration

Inheritance
object
MachineConfigurationHelper
Inherited Members
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

AxisLimitMax(ComWrapper<ICamApiMachineConfiguration>, int)

Get per-operation axis upper limit

Declaration
public static double AxisLimitMax(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
int index
Returns
Type Description
double

AxisLimitMin(ComWrapper<ICamApiMachineConfiguration>, int)

Get per-operation axis lower limit

Declaration
public static double AxisLimitMin(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
int index
Returns
Type Description
double

AxisLimitsEnabled(ComWrapper<ICamApiMachineConfiguration>, int)

Get whether per-operation axis limits are active (true) or inherited (false)

Declaration
public static bool AxisLimitsEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
int index
Returns
Type Description
bool

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

GetFlipIndexOf(ComWrapper<ICamApiMachineConfiguration>, string)

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

Declaration
public static int GetFlipIndexOf(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, string flipId)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
string flipId

Flip ID
Returns
Type Description
int

Robot6thAxisControl(ComWrapper<ICamApiMachineConfiguration>)

6th axis control settings for robot operations (IsNull if not applicable)

Declaration
public static ComWrapper<ICamApiMachineConfigurationRobot6thAxisControl> Robot6thAxisControl(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
Returns
Type Description
ComWrapper<ICamApiMachineConfigurationRobot6thAxisControl>

RobotRailMoveEnabled(ComWrapper<ICamApiMachineConfiguration>, int)

Get whether "Move up" is enabled for robot rail axis (index 0..RobotRailsCount-1)

Declaration
public static bool RobotRailMoveEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
int index

Rail axis index
Returns
Type Description
bool

RobotRailsCount(ComWrapper<ICamApiMachineConfiguration>)

Count of robot rail axes (linear external axes, max 3)

Declaration
public static int RobotRailsCount(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
Returns
Type Description
int

RobotRotaryTable(ComWrapper<ICamApiMachineConfiguration>)

Rotary table vector settings for robot operations (IsNull if not applicable)

Declaration
public static ComWrapper<ICamApiMachineConfigurationRobotRotaryTable> RobotRotaryTable(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
Returns
Type Description
ComWrapper<ICamApiMachineConfigurationRobotRotaryTable>

RobotTableAxesCount(ComWrapper<ICamApiMachineConfiguration>)

Count of robot table axes (rotary external axes, max 2)

Declaration
public static int RobotTableAxesCount(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
Returns
Type Description
int

RobotTableMoveEnabled(ComWrapper<ICamApiMachineConfiguration>, int)

Get whether "Move up" is enabled for robot table axis (index 0..RobotTableAxesCount-1)

Declaration
public static bool RobotTableMoveEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
int index

Table axis index
Returns
Type Description
bool

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

SetAxisLimitMax(ComWrapper<ICamApiMachineConfiguration>, int, double)

Set per-operation axis upper limit

Declaration
public static void SetAxisLimitMax(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, double value)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
int index
double value

SetAxisLimitMin(ComWrapper<ICamApiMachineConfiguration>, int, double)

Set per-operation axis lower limit

Declaration
public static void SetAxisLimitMin(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, double value)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
int index
double value

SetAxisLimitsEnabled(ComWrapper<ICamApiMachineConfiguration>, int, bool)

Set whether per-operation axis limits are active (true) or inherited (false)

Declaration
public static void SetAxisLimitsEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, bool value)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom
int index
bool value

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

SetRobotRailMoveEnabled(ComWrapper<ICamApiMachineConfiguration>, int, bool)

Set whether "Move up" is enabled for robot rail axis (index 0..RobotRailsCount-1)

Declaration
public static void SetRobotRailMoveEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, bool value)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
int index

Rail axis index
bool value

True to enable move-up

SetRobotTableMoveEnabled(ComWrapper<ICamApiMachineConfiguration>, int, bool)

Set whether "Move up" is enabled for robot table axis (index 0..RobotTableAxesCount-1)

Declaration
public static void SetRobotTableMoveEnabled(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, int index, bool value)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
int index

Table axis index
bool value

True to enable move-up

SetToolOrientationFromEvaluator(ComWrapper<ICamApiMachineConfiguration>, ComWrapper<ICamApiMachineEvaluator>)

Store the pose the evaluator currently holds into the operation, indexing the axes that carry the tool orientation. Works on an operation created programmatically, where SetAxesValues has no axes to update yet.

Declaration
public static void SetToolOrientationFromEvaluator(this ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom, ComWrapper<ICamApiMachineEvaluator> machineEvaluator)
Parameters
Type Name Description
ComWrapper<ICamApiMachineConfiguration> machineConfigurationCom

Machine configuration
ComWrapper<ICamApiMachineEvaluator> machineEvaluator

Machine evaluator seeded with InitMachineEvaluator and solved with CalcNextPos5D + SetNextPos