Home Support NI Product Manuals Switch Executive 2018 SP1 and 2019 Manual

Table Of Contents

Find Route (G Dataflow)

Download Manual | Offline Viewer Required
Version:
Last Modified: September 26, 2018

Identifies whether a route between two channels exists, is available, could be possible, or is not possible.

Programming Patterns

You can wire the route specification output returned by this node to Connect, Disconnect, and Connect And Disconnect.

connector_pane_image
datatype_icon

session in

Handle that identifies your Switch Executive virtual device session previously allocated by Open Session.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

channel 1

Channel name of one of the endpoints of the route to find.

The channel name must either be a channel alias name or a name in the device/ivichannel syntax.

datatype_icon

channel 2

Channel name of one of the endpoints of the route to find.

The channel name must either be a channel alias name or a name in the device/ivichannel syntax.

datatype_icon

session out

Reference to your virtual device session to wire to the next node.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
datatype_icon

route specification

String containing the fully specified route path surround by square brackets.

Requirements for Route Specification Strings

  • Any channel, other than an endpoint, within a route specification string must be reserved for routing or directly hardwired to one of the endpoint channels.
  • Channels used as endpoints must not be reserved for routing channels.
  • When connecting a route, the list of channels must obey the exclusion rules both explicitly in the route specification string as well as implicitly by any previous connections. Exclusion violations result in an error.

Syntax for Route Specification Strings

Route specification strings are the paths connecting two channels and are composed of one or more routes delimited by ampersands (&). For example, in the following line of syntax, there are three defined routes or route groups: routeOrGroup & routeOrGroup & routeOrGroup . . .

where routeOrGroup can be any of the following:

  • Route name
  • Route group name
  • Two endpoint channels to be connected that are delimited by ->, for example channel -> channel. Switch Executive dynamically determines the path between the endpoints. A hardwire alias name can be substituted for the endpoints.
  • Fully specified path enclosed in square brackets consisting of one or more endpoint channels delimited by ->, for example [channel -> channel -> channel . . .]

    where channel can be the following:

    • A channel alias name
    • A unique name created by combining the IVI device logical name and IVI channel name separated by a slash (/) delimiter, for example device/iviChan
    spd-note-note
    Note  

    Switch Executive has the option of finding an available path at run time by slightly modifying the syntax. Remove the square brackets and enter the two endpoints of a route delimited by a ->.

Examples of Route Specification String Syntax

The following are samples of route specification strings for a matrix:

String Route Specification Description
A->B Connect channel A to channel B. Switch Executive automatically determines the path between the two channels.
[SampleMatrix1/c0->SampleMatrix1/r1->SampleMatrix1/c4] A fully specified path between column 0 and column 4 of SampleMatrix1. Row 1 must be marked as reserved for routing.
[Scope->R3->SampleMatrix1/c6] A fully specified path between the channel named "Scope" and column 6 of SampleMatrix1. Row 3 must be marked as reserved for routing.
Scope->SampleMatrix1/c6 Connect the channel named "Scope" to column 6 of SampleMatrix1. Switch Executive automatically determines the path between the two channels.
ArbToInput & ScopeToOutput Complete the connections for route group ArbToInput and ScopeToOutput.
PowerDevice & [Scope->R3->UUT_Out] Complete the connections for route group PowerDevice and complete the fully specified path between the channel named "Scope" and the channel named "UUT_Out". R3 must be marked as a reserved for routing.
datatype_icon

path capability

Status of potential for a valid route between the two channels specified by the channel 1 and channel 2 inputs.

Name Value Description
Path Available 1

A path between the two channels is available. The route specification output returns a string describing the available path.

Path Exists 2

A path between the two channels already exists. The route specification output returns a string describing the existing path.

Path Unsupported 3

There is no potential path between the two channels given the current configuration.

Resource In Use 4

There is a potential path between the two channels, but a resource needed to complete the path is already in use.

Exclusion Conflict 5

The two channels cannot be connected because their connection would result in an exclusion violation.

Channel Not Available 6

One of the channels is not usable as an endpoint channel. Ensure that it is not marked as a configuration channel.

Channels Hardwired 7

The two channels reside on the same hardwire. An implicit path already exists.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application

Recently Viewed Topics