TfPyArg Class Reference

#include <pyArg.h>

Public Member Functions
	TfPyArg (const std::string &name, const std::string &typeDoc=std::string(), const std::string &defaultValueDoc=std::string())
const std::string &	GetName () const
	Returns argument name. More...
const std::string &	GetDefaultValueDoc () const
	Returns documentation for default value (if any) for this argument. More...
const std::string &	GetTypeDoc () const
	Returns documentation of type of value required by this argument. More...

Detailed Description

Class representing a function argument.

This is similar to hboost::python::arg, except it's not opaque and provides more fields for documentation purposes.

Definition at line 43 of file pyArg.h.

Constructor & Destructor Documentation

TfPyArg::TfPyArg ( const std::string &  name, const std::string &  typeDoc = std::string(), const std::string &  defaultValueDoc = std::string()  )

inline

Create a TfPyArg representing an argument with the given name. typeDoc and defaultValueDoc are optional documentation strings describing the expected type and default value of this argument.

Definition at line 49 of file pyArg.h.

Member Function Documentation

const std::string& TfPyArg::GetDefaultValueDoc ( ) const

inline

Returns documentation for default value (if any) for this argument.

Definition at line 60 of file pyArg.h.

const std::string& TfPyArg::GetName ( ) const

inline

Returns argument name.

Definition at line 56 of file pyArg.h.

const std::string& TfPyArg::GetTypeDoc ( ) const

inline

Returns documentation of type of value required by this argument.

Definition at line 64 of file pyArg.h.

---

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

• pxr/base/tf/pyArg.h