Adds the source frame to the target cluster.


icon

Inputs/Outputs

  • cbool.png wait for complete? (T) —

    wait for complete? Use this input only if the source object is a cluster (refer to the XNET Database Merge (Cluster) VI).

  • cgenclassrntag.png target cluster in —

    target cluster in is the I/O name of the cluster where the source frame is merged.

  • cgenclassrntag.png source frame —

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

  • cu32.png copy mode —

    copy mode defines the merging behavior if the target cluster already contains a frame with the same name.

  • cstr.png prefix —

    prefix is added to the source frame name if a frame with the same name exists in the target cluster.

  • cerrcodeclst.png error in (no error) —

    error in can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

  • iu32.png percent complete —

    percent complete is used when wait for complete? is false. (This output does not apply to the frame instance.)

  • igenclassrntag.png target cluster out —

    target cluster out is a copy of target cluster in. You can use this output to wire the VI to subsequent VIs.

  • ierrcodeclst.png error out —

    error out passes error or warning information out of a VI to be used by other VIs. Right-click the error out indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

    • 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.

    Description

    This VI 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 VI 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).