IECore::Parameterised Class Reference

#include <Parameterised.h>

Inheritance diagram for IECore::Parameterised:

List of all members.

Public Member Functions
	IE_CORE_DECLARERUNTIMETYPED (Parameterised, RunTimeTyped)
	Parameterised (const std::string &description)
	Parameterised (const std::string &description, CompoundParameterPtr compoundParameter)
	Another constructor added later on that gives defines the CompoundParameter object to be hold in this Parameterised instance.
const std::string &	description () const
	Returns a description for this parameterised object.
virtual CompoundParameterPtr	parameters ()
virtual ConstCompoundParameterPtr	parameters () const
	Returns the parameters for query.
CompoundObjectPtr	userData ()
	Returns an object that anyone can use for storing anything.
ConstCompoundObjectPtr	userData () const
	Read only version of the above.

---

Detailed Description

The Parameterised class provides a useful base class for all classes wishing to implement both RunTimeTyped and ParameterisedInterface.

---

Constructor & Destructor Documentation

IECore::Parameterised::Parameterised

(

const std::string &

description

)

The base class constructor receives the name and a short description about the Parameterised object created. They are usually defined within the derived class constructors.

---

Member Function Documentation

virtual CompoundParameterPtr IECore::Parameterised::parameters

(

)

[virtual]

Returns the parameters for editing. Subclasses should typically add parameters to this from their constructors.

Implements IECore::ParameterisedInterface.

---

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

• include/IECore/Parameterised.h