Description of an Attribute that can be optional. More...

Inheritance diagram for Foundry::Katana::FnOpDescription::OptionalAttrDescription:

Public Member Functions
bool	isOptional () const
	Gets whether the Attribute is optional or not.
const FnAttribute::Attribute	getDefaultValue () const
	Gets the default value of the Attribute, if it's optional.
void	setOptional (bool optional)
	Set whether the Attribute is optional.
void	setDefaultValue (const FnAttribute::Attribute &defaultValue)
	Set the default value of the Attribute. By calling this with an attribute that isn't a NullAttribute, you implicitly mark this Attribute as optional (so a call to setOptional() is ... optional).
void	setDefaultDescription (const std::string &defaultDescription)
	If you can't give a concrete default value (via a call to setDefaultValue()), you can use this to provide a description of how not providing this Attribute will affect the execution of the Op.
Protected Member Functions
	OptionalAttrDescription (AttrTypeDescription type, const std::string &name)

Detailed Description

Description of an Attribute that can be optional.

Description of an Attribute that can be optional, and what its default value is (if it is optional).

Constructor & Destructor Documentation

Foundry::Katana::FnOpDescription::OptionalAttrDescription::OptionalAttrDescription	(	AttrTypeDescription	type,
		const std::string &	name
	)		`[inline, protected]`

Parameters:

type	The type (AttrTypeDescription) of the Attribute.
name	The name of the Attribute.

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