Api.ConfigureAxis method

Configures the settings of a simulated axis.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsError ConfigureAxis(
       int Index,
       AxisDetails Details
)

Public Function ConfigureAxis(
       Index As Integer,
       Details As AxisDetails
) As KsError

Parameters

Index

Type: int

The index of a simulated axis. Indexes are zero based. Aliases affect this parameter.

Details

The AxisDetails class that contains information. Used to configure the servo drive settings.

Return value

A return code of a method.

Remarks

Allows for simulation of expected behavior when using a simulated axis.

Usable EtherCAT states

ecatOffline, ecatOP

Examples

N/A