Table Of Contents

Get Variant Attribute (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Returns either the value of a single variant attribute or the names and values of all variant attributes.

    To retrieve the names and values of all attributes, select Get All Attributes in the Behavior section of the Item tab.

    connector_pane_image
    datatype_icon

    variant

    The variant data for which you want to retrieve one or all attributes.

    datatype_icon

    name

    The name of the attribute whose value you want to retrieve.

    spd-note-note
    Note  

    This input is not available if you click this node on the diagram and select Get All Attributes in the Behavior section of the Item tab.

    datatype_icon

    default value

    A value and data type that you specify. This node returns default value if it does not find the attribute specified in name.

    spd-note-note
    Note  

    This input is not available if you click this node on the diagram and select Get All Attributes in the Behavior section of the Item tab.

    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

    variant out

    variant unchanged.

    datatype_icon

    found?

    A Boolean value that indicates whether the node found the attribute that is specified in name.

    True The node found the attribute specified in name.
    False The node did not find the attribute specified in name.
    spd-note-note
    Note  

    This output is replaced by a 1D array output containing the names of all of the attributes if you click this node on the diagram and select Get All Attributes in the Behavior section of the Item tab.

    datatype_icon

    names

    A 1D array containing the names of all attributes associated with the variant. This node sorts this array and arranges the array elements in ascending order using the same algorithm as Sort 1D Array.

    spd-note-note
    Note  

    This output is only available if you click this node on the diagram and select Get All Attributes in the Behavior section of the Item tab.

    datatype_icon

    value

    The value associated with the attribute you wire to name in variant format.

    spd-note-note
    Note  

    This output is replaced by a 1D array output containing the values of all of the attributes if you click this node on the diagram and select Get All Attributes in the Behavior section of the Item tab.

    datatype_icon

    values

    A 1D array containing the values associated with each attribute of the specified variant in variant format. The values in this array appear in the same order as their corresponding names appear in the names output.

    You must convert each attribute value to an appropriate data type.

    spd-note-note
    Note  

    This output is only available if you click this node on the diagram and select Get All Attributes in the Behavior section of the Item tab.

    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.

    Modes of Behavior

    This node has two modes of behavior depending on whether you select Get All Attributes in the Behavior section of the Item tab.

    Get All Attributes Node Behavior
    Selected The node returns the names of all attributes and their corresponding values in 1D arrays.
    Not selected The node searches for only the specified attribute. The names output changes to a Boolean output called found and the values output changes to a variant output called value. If the node does not find the specified attribute(s), or if it cannot convert the attribute(s) to the default value, found is False, and value displays the contents of default value.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics