NAME

comedi_test_route - validate and test device-global route

SYNOPSIS

#include <comedilib.h>

int comedi_test_route(comedi_t * device, unsigned int source, unsigned int destination);

STATUS

alpha

DESCRIPTION

This function validates a globally-named route as connectible and tests whether the route is connected. Note that since comedi_connect_route and comedi_disconnect_route effectively perform the same operations as comedi_set_routing / comedi_get_routing and comedi_dio_config, this operation will only report a route as connected _if_ both operations have been performed directly or effectively via comedi_connect_route. There are several routes that are not globally connectable via comedi_connect_route, such as (NI_PFI(i) --> NI_AO_SampleClock) as they must be connected via a trigger argument, such as comedi_cmd->start_arg for NI_AO_StartTrigger. This function can still be used for such routes to test whether they are valid.

The source parameter specifies the source of the signal route, whereas the destination parameter specifies the destination. Possible values for source and destination are driver dependent but are generally required to be values that are recognizable globally for a particular device, independent of sub-device.

RETURN VALUE

-1 if not connectible, 0 if connectible but not connected, 1 if connectible and connected.

AUTHORS

David Schleef <ds@schleef.org>

Frank Mori Hess <fmhess@users.sourceforge.net>

Herman Bruyninckx <Herman.Bruyninckx@mech.kuleuven.ac.be>

Bernd Porr <tech@linux-usb-daq.co.uk>

Ian Abbott <abbotti@mev.co.uk>

Éric Piel <piel@delmic.com>

Spencer Olson <olsonse@umich.edu>

COPYRIGHT

Copyright © 1998-2003 David Schleef
Copyright © 2001-2003, 2005, 2008 Frank Mori Hess
Copyright © 2002-2003 Herman Bruyninckx
Copyright © 2012 Bernd Porr
Copyright © 2012 Ian Abbott
Copyright © 2012, 2015 Éric Piel
Copyright © 2016-2018 Spencer Olson

This document is part of Comedilib. In the context of this document, the term "source code" as defined by the license is interpreted as the XML source.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 2.1 of the License.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.