SourceGet()

RSISource SourceGet ( )

pure virtual

Get the source of an error state for an Axis or MultiAxis.

Description:

SourceGet will return the first status bit which is set. The source can be checked when the Axis/MultiAxis is in an error state. There may be additional status bits set, use StatusBitGet to check any other bits.

Returns

(RSISource) The first status bit found.

Sample Code:

if (axis->StateGet() == RSIStateERROR)
{
 RSISource source = axis->SourceGet();
 printf("Source is %s\n", axis->SourceNameGet(source));
}

Note

Return defaults to RSISourceUNKNOWN. Also, this method might take several milliseconds to execute.

It's recommended to only call this method when trying to diagnose an Axis or MultiAxis Error state - StateGet().

RapidSetup:

Go to axis screen->Status tab.

When axis is in NO ERROR state

Axis is in ERROR state, the Source is Hardware Positive Limit

See also

RSISource, StateGet, SourceNameGet

Examples

AxisStatus.cpp, and AxisStatus.cs.