caffa::ObjectHandle Class Reference

#include <cafObjectHandle.h>

Inheritance diagram for caffa::ObjectHandle:

Collaboration diagram for caffa::ObjectHandle:

Public Types
using	InheritanceStackType = std::vector< std::string >
using	Ptr = std::shared_ptr< ObjectHandle >
using	ConstPtr = std::shared_ptr< const ObjectHandle >

Public Member Functions
virtual std::string	classKeyword () const
virtual InheritanceStackType	classInheritanceStack () const
virtual std::string	classDocumentation () const
std::list< FieldHandle * >	fields () const
std::list< MethodHandle * >	methods () const
FieldHandle *	findField (const std::string &keyword) const
MethodHandle *	findMethod (const std::string &keyword) const
void	addCapability (std::unique_ptr< ObjectCapability > capability)
template<typename CapabilityType >
CapabilityType *	capability () const
virtual std::string	uuid () const
virtual void	setUuid (const std::string &)
virtual ObjectHandle::Ptr	deepClone (caffa::ObjectFactory *optionalObjectFactory=nullptr) const =0
	Deep clone the object using an optional object factory. More...
virtual void	initAfterRead ()
void	disconnectObserverFromAllSignals (SignalObserver *observer)
void	accept (Inspector *visitor) const
void	accept (Editor *visitor)
Public Member Functions inherited from caffa::SignalObserver
std::list< AbstractSignal * >	observedSignals () const
void	addObservedSignal (AbstractSignal *signalToAdd) const
void	removeObservedSignal (AbstractSignal *signalToRemove) const noexcept
Public Member Functions inherited from caffa::SignalEmitter
void	addEmittedSignal (AbstractSignal *signalToAdd) const
std::list< AbstractSignal * >	emittedSignals () const

Static Public Member Functions
static std::string	classKeywordStatic ()
static bool	matchesClassKeyword (const std::string &classKeyword, const InheritanceStackType &inheritanceStack)
static constexpr bool	isValidCharacter (char c)
static constexpr bool	isValidKeyword (const std::string_view &type)

Protected Member Functions
void	addField (FieldHandle *field, const std::string &keyword)
void	addMethod (MethodHandle *method, const std::string &keyword, MethodHandle::Type type)

Detailed Description

The base class of all objects

Member Function Documentation

accept() [1/2]

void ObjectHandle::accept

(

Editor *

visitor

)

Accept the visit by an editing visitor

Parameters

visitor

accept() [2/2]

void ObjectHandle::accept

(

Inspector *

visitor

)

const

Accept the visit by an inspecting visitor

Parameters

visitor

addCapability()

void caffa::ObjectHandle::addCapability ( std::unique_ptr< ObjectCapability >  capability )

inline

Add an object capability to the object

Parameters

capability

the new capability

addField()

void ObjectHandle::addField ( FieldHandle *  field, const std::string &  keyword  )

protected

Add a field to the object

addMethod()

void ObjectHandle::addMethod ( MethodHandle *  method, const std::string &  keyword, MethodHandle::Type  type  )

protected

Add a method to the object

capability()

template<typename CapabilityType >

CapabilityType* caffa::ObjectHandle::capability ( ) const

inline

Get an object capability of the given type

Returns

a typed object capability

deepClone()

virtual ObjectHandle::Ptr caffa::ObjectHandle::deepClone ( caffa::ObjectFactory *  optionalObjectFactory = nullptr ) const

pure virtual

Deep clone the object using an optional object factory.

Parameters

optionalObjectFactory

if null the default object factory will be used

Returns

std::shared_ptr<Object>

Implemented in caffa::Object.

fields()

std::list< FieldHandle * > ObjectHandle::fields

(

)

const

The registered fields contained in this Object.

Returns

a vector of FieldHandle pointers

findField()

FieldHandle * ObjectHandle::findField

(

const std::string &

keyword

)

const

Find a particular field by keyword

Parameters

keyword

Returns

a FieldHandle pointer

findMethod()

MethodHandle * ObjectHandle::findMethod

(

const std::string &

keyword

)

const

Find a particular method by keyword

Parameters

keyword

Returns

a MethodHandle pointer

initAfterRead()

virtual void caffa::ObjectHandle::initAfterRead ( )

inlinevirtual

Method gets called from Document after all objects are read. Re-implement to set up internal pointers etc. in your data structure

isValidKeyword()

static constexpr bool caffa::ObjectHandle::isValidKeyword ( const std::string_view &  type )

inlinestaticconstexpr

Checks whether the keyword is a valid one. We accept regular letters and underscore '_'

methods()

std::list< MethodHandle * > ObjectHandle::methods

(

)

const

The registered methods for this Object.

Returns

a list of MethodHandle pointers

---

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

• /home/glindkvist/Projects/aru-server-app/frameworks/caffa/Core/cafObjectHandle.h
• /home/glindkvist/Projects/aru-server-app/frameworks/caffa/Core/cafObjectHandle.cpp