caffa::FieldHandle Class Reference

Base class for all fields, making it possible to handle them generically. More...

#include <cafFieldHandle.h>

Inheritance diagram for caffa::FieldHandle:

Public Member Functions
std::string	keyword () const
ObjectHandle *	ownerObject ()
const ObjectHandle *	ownerObject () const
virtual std::string	dataType () const =0
void	addCapability (std::unique_ptr< FieldCapability > capability)
template<typename CapabilityType >
CapabilityType *	capability ()
template<typename CapabilityType >
const CapabilityType *	capability () const
virtual void	accept (Inspector *visitor) const =0
virtual void	accept (Editor *visitor)=0
virtual bool	isReadable () const =0
virtual bool	isWritable () const =0
bool	isDeprecated () const
void	markDeprecated ()
void	setDocumentation (const std::string &documentation)
const std::string &	documentation () const

Protected Member Functions
bool	isInitialized () const
std::list< FieldCapability * >	capabilities ()

Friends
class	ObjectHandle

Detailed Description

Base class for all fields, making it possible to handle them generically.

Member Function Documentation

accept() [1/2]

virtual void caffa::FieldHandle::accept ( Inspector *  visitor ) const

pure virtual

Accept the visit by an inspecting visitor

Parameters

visitor

Implemented in caffa::ChildFieldBaseHandle, and caffa::DataField.

accept() [2/2]

virtual void caffa::FieldHandle::accept ( Editor *  visitor )

pure virtual

Accept the visit by an editing visitor

Parameters

visitor

Implemented in caffa::ChildFieldBaseHandle, and caffa::DataField.

isReadable()

virtual bool caffa::FieldHandle::isReadable ( ) const

pure virtual

Can the field be read. A non-scriptable field cannot be read within the client.

Implemented in caffa::Field< DataType >, caffa::Field< double >, caffa::Field< std::string >, caffa::ChildField< DataTypePtr >, caffa::ChildField< Child *>, caffa::ChildField< TestObj *>, caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

isWritable()

virtual bool caffa::FieldHandle::isWritable ( ) const

pure virtual

Can the field be written to. A non-scriptable field cannot be written to within the client.

Implemented in caffa::Field< DataType >, caffa::Field< double >, caffa::Field< std::string >, caffa::ChildField< DataTypePtr >, caffa::ChildField< Child *>, caffa::ChildField< TestObj *>, caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

---

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

• DataModel/cafFieldHandle.h
• DataModel/cafFieldHandle.cpp