These functions are used for handling the axes' sensitivities. More...

Functions
ScStatus	scGetAdvSens (int devIdx, ScAdvSens *asP)
	Retrieves the actual six sensitivity parameters of the advanced settings. More...

ScStatus	scSetAdvSens (int devIdx, ScAdvSens *asP)
	Sets and retrieves the six actual sensitivity parameters of the advanced settings. More...

ScStatus	scGetSens (int devIdx, int transSensP, int rotSensP)
	Retrieves the device's sensitivity. More...

ScStatus	scSetSens (int devIdx, int transSensP, int rotSensP)
	Sets and retrieves the device's sensitivity. More...

ScStatus	scGetXTraSens (int devIdx, int *sensP)
	Retrieves the device's sensitivity for the x-translation. More...

ScStatus	scSetXTraSens (int devIdx, int *sensP)
	Sets and retrieves the device's sensitivity for the x-axis' translation. More...

ScStatus	scGetYTraSens (int devIdx, int *sensP)
	Retrieves the device's sensitivity for the y-translation. More...

ScStatus	scSetYTraSens (int devIdx, int *sensP)
	Sets and retrieves the device's sensitivity for the y-axis' translation. More...

ScStatus	scGetZTraSens (int devIdx, int *sensP)
	Retrieves the device's sensitivity for the z-translation. More...

ScStatus	scSetZTraSens (int devIdx, int *sensP)
	Sets and retrieves the device's sensitivity for the z-axis' translation. More...

ScStatus	scGetXRotSens (int devIdx, int *sensP)
	Retrieves the device's sensitivity for the x-rotation. More...

ScStatus	scSetXRotSens (int devIdx, int *sensP)
	Sets and retrieves the device's sensitivity for the x-axis' rotation. More...

ScStatus	scGetYRotSens (int devIdx, int *sensP)
	Retrieves the SC device's sensitivity for the y-rotation. More...

ScStatus	scSetYRotSens (int devIdx, int *sensP)
	Sets and retrieves the SpaceControl device's sensitivity for the y-axis' rotation. More...

ScStatus	scGetZRotSens (int devIdx, int *sensP)
	Retrieves the device's sensitivity for the z-rotation. More...

ScStatus	scSetZRotSens (int devIdx, int *sensP)
	Sets and retrieves the device's sensitivity for the z-axis' rotation. More...

Detailed Description

These functions are used for handling the axes' sensitivities.

Function Documentation

◆ scGetAdvSens()

ScStatus scGetAdvSens	(	int	devIdx,
		ScAdvSens *	asP
	)

Retrieves the actual six sensitivity parameters of the advanced settings.

Example:

int       devIdx = 0;
ScAdvSens as;
ScStatus  status = scGetAdvSens(devIdx, &as);  // write the values back
if (status == SC_OK)
   printf("x-axis sensitivity: %d\n", as.mXSens);
else
   printf("error\n");

Parameters

devIdx index of the device the parameters are requested

Return values

asP	pointer to the sensitivity structure to be retrieved

Returns: 0: OK; <0: error

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetSens()

ScStatus scGetSens	(	int	devIdx,
		int *	transSensP,
		int *	rotSensP
	)

Retrieves the device's sensitivity.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      transSens, rotSens;
ScStatus status = scGetSens(devIdx, &transSens, &rotSens);
if (status == SC_OK)
   printf("transitional sensitivity: %d\n", transSens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

transSensP	sensitivity regarding translational displacement (0..15)
rotSensP	sensitivity regarding rotational displacement (0..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetXRotSens()

ScStatus scGetXRotSens	(	int	devIdx,
		int *	sensP
	)

Retrieves the device's sensitivity for the x-rotation.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      sens;
ScStatus status = scGetXRotSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetXTraSens()

ScStatus scGetXTraSens	(	int	devIdx,
		int *	sensP
	)

Retrieves the device's sensitivity for the x-translation.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      sens;
ScStatus status = scGetXTraSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetYRotSens()

ScStatus scGetYRotSens	(	int	devIdx,
		int *	sensP
	)

Retrieves the SC device's sensitivity for the y-rotation.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      sens;
ScStatus status = scGetYRotSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetYTraSens()

ScStatus scGetYTraSens	(	int	devIdx,
		int *	sensP
	)

Retrieves the device's sensitivity for the y-translation.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      sens;
ScStatus status = scGetYTraSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetZRotSens()

ScStatus scGetZRotSens	(	int	devIdx,
		int *	sensP
	)

Retrieves the device's sensitivity for the z-rotation.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      sens;
ScStatus status = scGetZRotSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetZTraSens()

ScStatus scGetZTraSens	(	int	devIdx,
		int *	sensP
	)

Retrieves the device's sensitivity for the z-translation.

The sensitivity gives the relationship between the displacement of the cap and the standard data values produced by the device. Higher sensitivity values mean that the device will produce higher standard data values.
Example:

int      devIdx = 0;
int      sens;
ScStatus status = scGetZTraSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetAdvSens()

ScStatus scSetAdvSens	(	int	devIdx,
		ScAdvSens *	asP
	)

Sets and retrieves the six actual sensitivity parameters of the advanced settings.

Example:

int       devIdx = 0;
ScAdvSens as;
ScStatus  status = scGetAdvSens(devIdx, &as); // get the actual values
if (status == SC_OK)
   printf("x-axis sensitivity: %d\n", as.mXSens);
else
   printf("error\n");
as.mXSens = 10;                               // change one value
status = scSetAdvSens(devIdx, &as);           // write the values back
if (status == SC_OK)
   printf("x-axis sensitivity: %d\n", as.mXSens);
else
   printf("error\n");

Parameters

devIdx index of the device the parameters are requested

Return values

asP	pointer to the sensitivity structure to be retrieved

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX, SC_PARAMETER_OUT_OF_RANGE

References SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetSens()

ScStatus scSetSens	(	int	devIdx,
		int *	transSensP,
		int *	rotSensP
	)

Sets and retrieves the device's sensitivity.

See scGetSens() for details.
Attention: For the time being only parameter transSensP is used, whatever is given in parameter rotSensP is ignored and replaced by the same value as given in transSensP. I. e. you can not set different sensitivity values for translation and rotation with this function. If you want to achieve this use functions scGetXTraSens() etc. and scSetXRotSens() etc. To calculate the resulting sensitivity for an axis the driver adds the sensitivities set with scSetSens() and the functions scGetXTraSens() etc. Example:

int devIdx    = 0;
int transSens = 10;
int rotSens   = 5;  // this value does not matter, see comment above
ScStatus status = scSetSens(devIdx, &transSens, &rotSens);
if (status == SC_OK)
   printf("transitional sensitivity: %d\n", transSens);
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

transSensP	sensitivity regarding translational displacement (0..15)
rotSensP	sensitivity regarding rotational displacement (0..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX, SC_PARAMETER_OUT_OF_RANGE

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetXRotSens()

ScStatus scSetXRotSens	(	int	devIdx,
		int *	sensP
	)

Sets and retrieves the device's sensitivity for the x-axis' rotation.

See scGetXRotSens() for details.
Example:

int      devIdx = 0;
int      sens   = 12;
ScStatus status = scSetXRotSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetXTraSens()

ScStatus scSetXTraSens	(	int	devIdx,
		int *	sensP
	)

Sets and retrieves the device's sensitivity for the x-axis' translation.

See scGetXTraSens() for details.
Example:

int      devIdx = 0;
int      sens   = 12;
ScStatus status = scSetXTraSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetYRotSens()

ScStatus scSetYRotSens	(	int	devIdx,
		int *	sensP
	)

Sets and retrieves the SpaceControl device's sensitivity for the y-axis' rotation.

See scGetYRotSens() for details.
Example:

int      devIdx = 0;
int      sens   = 12;
ScStatus status = scSetYRotSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetYTraSens()

ScStatus scSetYTraSens	(	int	devIdx,
		int *	sensP
	)

Sets and retrieves the device's sensitivity for the y-axis' translation.

See scGetYTraSens() for details.
Example:

int      devIdx = 0;
int      sens   = 12;
ScStatus status = scSetYTraSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetZRotSens()

ScStatus scSetZRotSens	(	int	devIdx,
		int *	sensP
	)

Sets and retrieves the device's sensitivity for the z-axis' rotation.

See scGetZRotSens() for details.
Example:

int      devIdx = 0;
int      sens   = 12;
ScStatus status = scSetZRotSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetZTraSens()

ScStatus scSetZTraSens	(	int	devIdx,
		int *	sensP
	)

Sets and retrieves the device's sensitivity for the z-axis' translation.

See scGetZTraSens() for details.
Example:

int      devIdx = 0;
int      sens   = 12;
ScStatus status = scSetZTraSens(devIdx, &sens);
if (status == SC_OK)
   printf("sensitivity: %d\n", sens);
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

sensP actual sensitivity (1..15)

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References MAX_SENS, MIN_SENS, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

Functions

Detailed Description

Function Documentation

◆ scGetAdvSens()

◆ scGetSens()

◆ scGetXRotSens()

◆ scGetXTraSens()

◆ scGetYRotSens()

◆ scGetYTraSens()

◆ scGetZRotSens()

◆ scGetZTraSens()

◆ scSetAdvSens()

◆ scSetSens()

◆ scSetXRotSens()

◆ scSetXTraSens()

◆ scSetYRotSens()

◆ scSetYTraSens()

◆ scSetZRotSens()

◆ scSetZTraSens()