Class ApproachReturnCommandHelper

Helper methods for ICamIpcApproachReturnCommand. Position type, axis mode and axis kind are integers mirroring the CAMAPI enums TCamApiApproachReturnPositionType / TCamApiApproachReturnAxisMode / TCamApiApproachReturnAxisKind.

Inheritance

object

ApproachReturnCommandHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMIPC.DotnetHelper

Assembly: CAMIPC.DotnetHelper.dll

Syntax

public static class ApproachReturnCommandHelper

Methods

AxisCount(ComWrapper<ICamIpcApproachReturnCommand>)

Number of controllable axes of the command.

Declaration

public static int AxisCount(this ComWrapper<ICamIpcApproachReturnCommand> commandCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom

Returns

Type	Description
int

GetAxisId(ComWrapper<ICamIpcApproachReturnCommand>, int)

Address (name) of the axis at the given index.

Declaration

public static string GetAxisId(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex

Returns

Type	Description
string

GetAxisKind(ComWrapper<ICamIpcApproachReturnCommand>, int)

Group of the axis at the given index.

Declaration

public static int GetAxisKind(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex

Returns

Type	Description
int

GetAxisMode(ComWrapper<ICamIpcApproachReturnCommand>, int)

How the axis at the given index is defined (unset/value/auto).

Declaration

public static int GetAxisMode(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex

Returns

Type	Description
int

GetAxisValue(ComWrapper<ICamIpcApproachReturnCommand>, int)

Manual value of the axis at the given index.

Declaration

public static double GetAxisValue(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex

Returns

Type	Description
double

GetPositionType(ComWrapper<ICamIpcApproachReturnCommand>)

Position type of the command.

Declaration

public static int GetPositionType(this ComWrapper<ICamIpcApproachReturnCommand> commandCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom

Returns

Type	Description
int

SetAxisAuto(ComWrapper<ICamIpcApproachReturnCommand>, int)

Set the axis at the given index to Auto.

Declaration

public static void SetAxisAuto(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex

SetAxisUnset(ComWrapper<ICamIpcApproachReturnCommand>, int)

Unset the axis at the given index (keep the value from the current machine state).

Declaration

public static void SetAxisUnset(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex

SetAxisValue(ComWrapper<ICamIpcApproachReturnCommand>, int, double)

Set the axis at the given index to a fixed manual value.

Declaration

public static void SetAxisValue(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int axisIndex, double value)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	axisIndex
double	value

SetPositionType(ComWrapper<ICamIpcApproachReturnCommand>, int)

Set the position type of the command; changing it rebuilds the command's axis set.

Declaration

public static void SetPositionType(this ComWrapper<ICamIpcApproachReturnCommand> commandCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApproachReturnCommand>	commandCom
int	value