Katana Plug-in APIs 0.1
Public Member Functions | Protected Member Functions

Foundry::Katana::FnOpDescription::AttrDescription Class Reference

Description of a generic Attribute. More...

#include <FnOpDescriptionBuilder.h>

Inheritance diagram for Foundry::Katana::FnOpDescription::AttrDescription:
Foundry::Katana::FnOpDescription::OptionalAttrDescription Foundry::Katana::FnOpDescription::OutputAttrDescription Foundry::Katana::FnOpDescription::InputAttrDescription Foundry::Katana::FnOpDescription::OpArgDescription

List of all members.

Public Member Functions

const std::string & getDescription () const
 Get the description of the Attribute's usage.
const std::string & getName () const
 Get the name of the Attribute.
AttrTypeDescription getAttrType () const
 Get the type (AttrTypeDescription) of the Attribute.
void setDescription (const std::string &description)
 Set the description of the Attribute's usage.

Protected Member Functions

 AttrDescription (AttrTypeDescription type, const std::string &name)

Detailed Description

Description of a generic Attribute.

Description of a generic Attribute, including name, type and a description of its usage.


Constructor & Destructor Documentation

Foundry::Katana::FnOpDescription::AttrDescription::AttrDescription ( AttrTypeDescription  type,
const std::string &  name 
) [inline, protected]
Parameters:
typeThe type (AttrTypeDescription) of the Attribute.
nameThe name of the Attribute.

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator