egd_sensor_name(3) [debian man page]

EGD_SENSOR_TYPE(3)					       EEGDEV library manual						EGD_SENSOR_TYPE(3)

NAME

       egd_sensor_type, egd_sensor_name - Get the id or name of a sensor type

SYNOPSIS

       #include <eegdev.h>

       int egd_sensor_type(const char* sname);
       const char* egd_sensor_name(int stype);

DESCRIPTION

       egd_sensor_type()  returns  the	identifier code of the sensor type named sname. egd_sensor_name() is the reverse process: it retrieves the
       name of the sensor type identified by stype.

       Depending on which acquisition devices have been accessed by the library, the sensor type identifier for a given name may be different from
       a  previous program execution. However once a association has been established it is ensured that it will remain the same until the process
       termination.  Additionally, the sensor types named "eeg", "trigger" and "undefined" are always associated respectively to 0, 1 and 2.

RETURN VALUE

       In case of success, egd_sensor_type() returns a non negative value corresponding to the identifier of the sensor type called name.   Other-
       wise it returns -1.

       In case of success, egd_sensor_name() returns the name of the sensor type identified by stype. Otherwise, NULL is returned and errno is set
       accordingly.

ERRORS

       egd_sensor_type() or egd_sensor_name() will fail if:

       EINVAL sname is NULL or refers to an unknown sensor type or if stype is not a known sensor type identifier.

SEE ALSO

       egd_get_numch(3) egd_get_cap(3)

EPFL
								       2011							EGD_SENSOR_TYPE(3)

EGD_GET_CAP(3)						       EEGDEV library manual						    EGD_GET_CAP(3)

NAME

       egd_get_cap - Query various information about the device capabilities

SYNOPSIS

       #include <eegdev.h>

       int egd_get_cap(const struct eegdev* dev, int cap, void* val);

DESCRIPTION

       egd_get_cap()  returns  the  information about the capability specified by cap of the recording device referenced by dev by the mean of the
       pointer val.

       The type of pointer passed through val is dependent on the requested capability cap which can be  one  the  following  (The  expected  type
       pointed by val is provided in parenthesis):

       EGD_CAP_FS (int)
	      Sampling frequency that is currently set. The same value is returned by the function.

       EGD_CAP_TYPELIST (const int*)
	      Array  of  sensor  types	sampled  by the device terminated by -1. These values became valid as argument for egd_sensor_name(3) when
	      opening the device dev if they were not yet before. The number of elements in the array (excluding the -1 element)  is  provided	by
	      the return value of the function.

       EGD_CAP_DEVTYPE (const char*)
	      Null  terminated	string	describing the type of the recording device (Manufacturer and model if dev refers to actual hardware). The
	      length of string (excluding the null character) is provided by the return value of the function.

       EGD_DEVID (const char*)
	      Null-terminated string describing the model of the recording device (or an unique identifier of the resource). The length of  string
	      (excluding the null character) is provided by the return value of the function.

RETURN VALUE

       In case of success, the function returns a positive value depending on the requested capability. Otherwise, -1 is returned and errno is set
       accordingly.

ERRORS

       egd_get_cap() will fail if:

       EINVAL dev is NULL, cap is not valid value or val is NULL while cap is not EGD_CAP_FS.

SEE ALSO

       egd_sensor_name(3)

EPFL
								       2011							    EGD_GET_CAP(3)