SourceNameGet()

char * SourceNameGet ( RSISource  source )

pure virtual

Get the name (string) of the source of an error for an Axis or MultiAxis.

Description:

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

Parameters

source

(RSISource)

Returns

(char*) The name of the RSISource.

Sample Code:

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

RapidSetup:

Go to Axis screen, Status tab.

This displays the various bit that are checked if axis is in error state

Note

See also

RSISource, StateGet

Examples

AxisStatus.cpp, and AxisStatus.cs.