.. _omni_graph_nodes_ToString_1:

.. _omni_graph_nodes_ToString:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: To String
    :keywords: lang-en omnigraph node function threadsafe nodes to-string


To String
=========

.. <description>

Converts the given input to a string equivalent.

.. </description>


Installation
------------

To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "value (*inputs:value*)", "``any``", "The value to be converted to a string.  Numeric values are converted using C++'s std::ostringstream << operator. This can result in the values being converted to exponential form. E.g: 1.234e+06 Arrays of numeric values are converted to Python list syntax. E.g: [1.5, -0.03] A uchar value is converted to a single, unquoted character. An array of uchar values is converted to an unquoted string. Avoid zero values (i.e. null chars) in the array as the behavior is undefined and may vary over time. A single token is converted to its unquoted string equivalent. An array of tokens is converted to Python list syntax with each token enclosed in double quotes. E.g. [""first"", ""second""]", "None"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "String (*outputs:converted*)", "``string``", "Output string", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.graph.nodes.ToString"
    "Version", "1"
    "Extension", "omni.graph.nodes"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "To String"
    "Categories", "function"
    "Generated Class Name", "OgnToStringDatabase"
    "Python Module", "omni.graph.nodes"

