All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RmanArgsParserPlugin Class Reference

Parses Args files. More...

+ Inheritance diagram for RmanArgsParserPlugin:

Public Member Functions

RMAN_ARGS_PARSER_API
NdrNodeUniquePtr 
Parse (const NdrNodeDiscoveryResult &discoveryRes) override
 Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new NdrNode. More...
 
RMAN_ARGS_PARSER_API const
NdrTokenVec & 
GetDiscoveryTypes () const override
 Returns the types of nodes that this plugin can parse. More...
 
RMAN_ARGS_PARSER_API const
TfToken
GetSourceType () const override
 Returns the source type that this parser operates on. More...
 
RMAN_ARGS_PARSER_API
NdrNodeUniquePtr 
Parse (const NdrNodeDiscoveryResult &discoveryRes) override
 Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new NdrNode. More...
 
RMAN_ARGS_PARSER_API const
NdrTokenVec & 
GetDiscoveryTypes () const override
 Returns the types of nodes that this plugin can parse. More...
 
RMAN_ARGS_PARSER_API const
TfToken
GetSourceType () const override
 Returns the source type that this parser operates on. More...
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase__GetTfWeakBase__ () const
 
const TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Additional Inherited Members

- Static Public Member Functions inherited from NdrParserPlugin
static NDR_API NdrNodeUniquePtr GetInvalidNode (const NdrNodeDiscoveryResult &dr)
 Gets an invalid node based on the discovery result provided. More...
 
- Protected Member Functions inherited from TfWeakBase
TfRefPtr< Tf_Remnant > _Register () const
 
template<class T >
TfRefPtr< Tf_Remnant > _Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

Detailed Description

Parses Args files.

For more information on parser plugins, see the documentation for NdrParserPlugin.

Schema

The following elements, along with their attributes (italics) and child elements, are respected in this parser:

  • and <output>
    • <help>
    • <hintdict>
      • <string>
        • name
        • value
      • name
    • <hintlist>
      • <string>
        • value
      • name
    • <tags>
      • <tag>
        • value
    • name
    • type *!* (deprecated on outputs only)
    • default
    • label
    • widget
    • arraySize
    • isDynamicArray
    • connectable
    • options
    • page
    • input *!*
    • help
    • tag *!*
    • validConnectionTypes
    • vstructmember
    • Note: other uncategorized attributes are available via NdrNode::GetHints()
  • <page> Can be nested
    • name
  • <help>
  • <primvars>
    • <primvar>
      • name
  • <departments>
  • <shaderType>
    • name
    • <tag>
      • value
  • <typeTag> *!*
    • <tag>
      • value

For more information on the specifics of what any of these elements or attributes mean, see the Renderman documentation on the Args format. Items marked with a '!' are deprecated and will output a warning.

Definition at line 103 of file rmanArgsParser.h.

Member Function Documentation

RMAN_ARGS_PARSER_API const NdrTokenVec& GetDiscoveryTypes ( ) const
overridevirtual

Returns the types of nodes that this plugin can parse.

"Type" here is the discovery type (in the case of files, this will probably be the file extension, but in other systems will be data that can be determined during discovery). This type should only be used to match up a NdrNodeDiscoveryResult to its parser plugin; this value is not exposed in the node's API.

Implements NdrParserPlugin.

RMAN_ARGS_PARSER_API const NdrTokenVec& GetDiscoveryTypes ( ) const
overridevirtual

Returns the types of nodes that this plugin can parse.

"Type" here is the discovery type (in the case of files, this will probably be the file extension, but in other systems will be data that can be determined during discovery). This type should only be used to match up a NdrNodeDiscoveryResult to its parser plugin; this value is not exposed in the node's API.

Implements NdrParserPlugin.

RMAN_ARGS_PARSER_API const TfToken& GetSourceType ( ) const
overridevirtual

Returns the source type that this parser operates on.

A source type is the most general type for a node. The parser plugin is responsible for parsing all discovery results that have the types declared under GetDiscoveryTypes(), and those types are collectively identified as one "source type".

Implements NdrParserPlugin.

RMAN_ARGS_PARSER_API const TfToken& GetSourceType ( ) const
overridevirtual

Returns the source type that this parser operates on.

A source type is the most general type for a node. The parser plugin is responsible for parsing all discovery results that have the types declared under GetDiscoveryTypes(), and those types are collectively identified as one "source type".

Implements NdrParserPlugin.

RMAN_ARGS_PARSER_API NdrNodeUniquePtr Parse ( const NdrNodeDiscoveryResult discoveryResult)
overridevirtual

Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new NdrNode.

The node's name, source type, and family must match.

Implements NdrParserPlugin.

RMAN_ARGS_PARSER_API NdrNodeUniquePtr Parse ( const NdrNodeDiscoveryResult discoveryResult)
overridevirtual

Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new NdrNode.

The node's name, source type, and family must match.

Implements NdrParserPlugin.


The documentation for this class was generated from the following files: