omni.graph.tools.ogn

Classes Summary:

AttributeKeys	Container for the text for all of the .ogn keywords used at the attribute definition level
AttributeManager	Base class that provides support methods common to all types of attributes
CarbLogError	Exception to raise when there is an error that requires logging
CategoryTypeValues	Container for the set of values allowed for defining node type categories
CudaPointerValues	Container for the set of values .ogn accepts for the cudaPointers node type
DataTypeError	Exception type to raise when there is a problem with the data type conversions
DataTypeNameRepresentation	Enumeration of recognized data type name representations. The order of the enums corresponds to the order of
DebugError	Exception to raise when there is an error that requires a debug message but no specific action
ExclusionTypeValues	Container for the .ogn keywords allowed for types of generated code that can be excluded
GraphSetupKeys	Container for keywords encapsulating the graph setup entries in the test dictionary, v2+.
IconKeys	Holder for the set of keywords that could appear in the icon dictionary
LanguageTypeValues	Holder for the set of values that define a language specification
MemoryTypeValues	Holder for the set of keywords identifying memory types
MetadataKeys	Holder for common metadata information
NodeGenerationError	Exception to raise when there is an error in the generation of the node interface, tests, or documentation
NodeTypeKeys	Container for the text for all of the .ogn keywords used at the node definition level
ParseError	Exception to raise when there is an error in the parsing of the node interface description
SchedulingHints	Class managing the scheduling hints.
TestKeys	Container for the text for all of the .ogn keywords used at the test definition level
UnimplementedError	Custom exception to raise when attempting to access unimplemented functionality

Functions Summary:

code_generation	Run the code generator on the ogn input, which is in the same JSON format as the .ogn file
convert_type_name	Convert the name of a specific supported data type between two different representations.
expand_attribute_union_groups	Expands any group names in a union type declaration, in-place. The
generate_cpp	Create support files for the C++ interface to a node
generate_documentation	Create support files for the documentation of a node
generate_python	Create support files for the pythonic interface to a node
generate_template	Create support files for the C++ interface to a node
generate_test_imports	Generates a set of imports for the ogn test modules contained in a directory.
generate_tests	Create support files for the tests on the node
generate_usd	Create support files for the USD template definition for a node
get_attribute_manager	Deciphers, validates, and provides consistent access to attributes described by a dictionary.
get_attribute_manager_type	Returns an attribute manager that matches the name and type, with no other data.
split_attribute_type_name	Split a fully qualified attribute type name into its identifying parts
to_cpp_comment	Convert a multiline string into a C++ comment
to_python_comment	Convert a multiline string into a Python comment
to_usd_comment	Convert a multiline string into a USD comment
to_usd_docs	Returns the USD documentation as a list of strings with the docs= included