Class ApproachReturnRuleHelper

Helper methods for ICamIpcApproachReturnRule

Inheritance
object
ApproachReturnRuleHelper
Inherited Members
Namespace: CAMIPC.DotnetHelper
Assembly: CAMIPC.DotnetHelper.dll
Syntax
public static class ApproachReturnRuleHelper

Methods

AddCommand(ComWrapper<ICamIpcApproachReturnRule>, int)

Append a new command of the given position type at the end. Returns the new command.

Declaration
public static ComWrapper<ICamIpcApproachReturnCommand> AddCommand(this ComWrapper<ICamIpcApproachReturnRule> ruleCom, int positionType)
Parameters
Type Name Description
ComWrapper<ICamIpcApproachReturnRule> ruleCom
int positionType
Returns
Type Description
ComWrapper<ICamIpcApproachReturnCommand>

Clear(ComWrapper<ICamIpcApproachReturnRule>)

Remove all commands from the rule.

Declaration
public static void Clear(this ComWrapper<ICamIpcApproachReturnRule> ruleCom)
Parameters
Type Name Description
ComWrapper<ICamIpcApproachReturnRule> ruleCom

CommandCount(ComWrapper<ICamIpcApproachReturnRule>)

Number of commands currently in the rule.

Declaration
public static int CommandCount(this ComWrapper<ICamIpcApproachReturnRule> ruleCom)
Parameters
Type Name Description
ComWrapper<ICamIpcApproachReturnRule> ruleCom
Returns
Type Description
int

DeleteCommand(ComWrapper<ICamIpcApproachReturnRule>, int)

Delete the command at the given index.

Declaration
public static void DeleteCommand(this ComWrapper<ICamIpcApproachReturnRule> ruleCom, int index)
Parameters
Type Name Description
ComWrapper<ICamIpcApproachReturnRule> ruleCom
int index

GetCommand(ComWrapper<ICamIpcApproachReturnRule>, int)

Command at the given index. Throws if the index is out of range.

Declaration
public static ComWrapper<ICamIpcApproachReturnCommand> GetCommand(this ComWrapper<ICamIpcApproachReturnRule> ruleCom, int index)
Parameters
Type Name Description
ComWrapper<ICamIpcApproachReturnRule> ruleCom
int index
Returns
Type Description
ComWrapper<ICamIpcApproachReturnCommand>