IInspectSerializer

class omni.inspect.IInspectSerializer

Bases: _IInspectSerializer

Base class for object serialization requests.

Methods

__init__(*args, **kwargs)	Overloaded function.
as_string(self)	Get the current output as a string.
clear(self)	Clear the contents of the serializer output, either emptying the file or clearing the string, depending on where the current output is directed.
set_output_to_string(self)	Set the output location of the serializer data to be a local string.
write_string(self, to_write)	Write a fixed string to the serializer output location

Attributes

output_location
output_to_file_path

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: omni.inspect._omni_inspect.IInspectSerializer, arg0: omni.core._core.IObject) -> None

2. __init__(self: omni.inspect._omni_inspect.IInspectSerializer) -> None

as_string(

self: omni.inspect._omni_inspect._IInspectSerializer,

) → str

Get the current output as a string.

@returns The output that has been sent to the serializer. If the output is being sent to a file path then read the file at that path and return the contents of the file. If the output is being sent to stdout or stderr then nothing is returned as that output is unavailable after flushing.

clear(

self: omni.inspect._omni_inspect._IInspectSerializer,

) → None

Clear the contents of the serializer output, either emptying the file or clearing the string, depending on where the current output is directed.

set_output_to_string(

self: omni.inspect._omni_inspect._IInspectSerializer,

) → None

Set the output location of the serializer data to be a local string. No check is made to ensure that the string size doesn’t get too large so when in doubt use a file path.

write_string(

self: omni.inspect._omni_inspect.IInspectSerializer,

to_write: str,

) → None

Write a fixed string to the serializer output location

@param[in] toWrite String to be written to the serializer