Table Of Contents

XNET Database Merge (XNET Database Merge (Frame)) (G Dataflow)

Last Modified: November 2, 2017

Merges a frame object with all child objects into the destination cluster.

connector_pane_image
datatype_icon

wait for complete?

An input used to split the merging process into parts (for example, to display a progress bar).

datatype_icon

target cluster in

The I/O name of the cluster where the source cluster is merged.

datatype_icon

source frame

The I/O name of the frame to be merged into the target cluster.

datatype_icon

copy mode

An input that defines the merging behavior if the target cluster already contains elements with the same name.

datatype_icon

prefix

An input added to the source cluster name if an element with the same name exists in the target cluster.

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

percent complete

An output used when wait for complete? is false.

datatype_icon

target cluster out

A copy of target cluster in. You can use this output to wire the node to subsequent nodes.

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.

Description

This node merges a frame with all dependent child objects (PDUs, subframes, and signals) to the target cluster.

If the source frame name was not used in the target cluster, this node copies the source frame with the child objects to the target. If a frame with the same name exists in the target cluster, you can avoid name collisions by specifying the prefix to be added to the name.

If a frame with the same name exists in the target cluster, the merge behavior depends on the copy mode input:

  • Copy using source: The target frame with all dependent child objects is removed from the target cluster and replaced by the source objects.
  • Copy using destination: The source frame is ignored (the target cluster frame with child objects remains unchanged).
  • Merge using source: This adds child objects from the source frame to child objects from the destination frame. If the target frame contains a child object with the same name, it is replaced by the child object from the source frame. The source frame properties (for example, payload length) replace the target frame properties.
  • Merge using destination: This adds child objects from the source frame to child objects from the destination frame. If the target frame contains a child object with the same name, it remains unchanged. The target frame properties remain unchanged (for example, payload length).

Example

Target frame F1(v1) has signals S1 and S2(v1). Source frame F1(v2) has signals S2(v2) and S3.

(v1) and (v2) are two versions of one object with same name, but with different properties.

  • Result of Copy using source: F1(v2), S2(v2), S3.
  • Result of Copy using destination: F1(v1), S1, S2(v1).
  • Result of Merge using source: F1(v2), S1, S2(v2), S3.
  • Result of Merge using destination: F1(v1), S1, S2(v1), S3.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Supported

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


Recently Viewed Topics