caffa::ChildArrayFieldHandle Class Reference

A non-templated base interface for ChildArrayField<DataType*> Used so we can have pointers to any ChildArrayField. More...

#include <cafChildArrayFieldHandle.h>

Inheritance diagram for caffa::ChildArrayFieldHandle:

Collaboration diagram for caffa::ChildArrayFieldHandle:

Public Member Functions
virtual size_t	size () const =0
	Get the number of child objects. More...
bool	empty () const override
	Check if the child array field is empty. More...
virtual void	clear ()=0
	Clear all content.
virtual void	erase (size_t index)=0
	Erase a particular child object by index. More...
virtual std::shared_ptr< ObjectHandle >	at (size_t index)=0
	Get a raw pointer to the object at a particular index. More...
virtual void	insertAt (size_t index, std::shared_ptr< ObjectHandle > obj)=0
	Insert an object at a particular index. Ownership will be taken. More...
virtual void	push_back_obj (std::shared_ptr< ObjectHandle > obj)=0
	push back and object taking over ownership. More...
virtual void	setAccessor (std::unique_ptr< ChildArrayFieldAccessor > accessor)=0
	Set a new accessor. More...
Public Member Functions inherited from caffa::ChildFieldBaseHandle
virtual std::string	childClassKeyword () const =0
	Get the class keyword of the contained child(ren)
virtual std::vector< std::shared_ptr< ObjectHandle > >	childObjects ()=0
virtual std::vector< std::shared_ptr< const ObjectHandle > >	childObjects () const =0
void	accept (Inspector *visitor) const override
void	accept (Editor *editor) override
Public Member Functions inherited from caffa::FieldHandle
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 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

Additional Inherited Members
Protected Member Functions inherited from caffa::FieldHandle
bool	isInitialized () const
std::list< FieldCapability * >	capabilities ()

Detailed Description

A non-templated base interface for ChildArrayField<DataType*> Used so we can have pointers to any ChildArrayField.

Member Function Documentation

at()

virtual std::shared_ptr<ObjectHandle> caffa::ChildArrayFieldHandle::at ( size_t  index )

pure virtual

Get a raw pointer to the object at a particular index.

Parameters

index

The index to look up

Returns

A raw pointer to the Caffa object.

Implemented in caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

empty()

bool caffa::ChildArrayFieldHandle::empty ( ) const

inlineoverridevirtual

Check if the child array field is empty.

Returns

true if empty

false if there are child objects.

Implements caffa::ChildFieldBaseHandle.

erase()

virtual void caffa::ChildArrayFieldHandle::erase ( size_t  index )

pure virtual

Erase a particular child object by index.

Parameters

index

the index to the object

Implemented in caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

insertAt()

virtual void caffa::ChildArrayFieldHandle::insertAt ( size_t  index, std::shared_ptr< ObjectHandle >  obj  )

pure virtual

Insert an object at a particular index. Ownership will be taken.

Parameters

index	the index to insert at
obj	A unique pointer to the object.

Implemented in caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

push_back_obj()

virtual void caffa::ChildArrayFieldHandle::push_back_obj ( std::shared_ptr< ObjectHandle >  obj )

pure virtual

push back and object taking over ownership.

Parameters

obj	object to take.

Implemented in caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

setAccessor()

virtual void caffa::ChildArrayFieldHandle::setAccessor ( std::unique_ptr< ChildArrayFieldAccessor >  accessor )

pure virtual

Set a new accessor.

Parameters

accessor

Implemented in caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

size()

virtual size_t caffa::ChildArrayFieldHandle::size ( ) const

pure virtual

Get the number of child objects.

Returns

size_t

Implemented in caffa::ChildArrayField< DataTypePtr >, and caffa::ChildArrayField< Child *>.

---

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

• DataModel/cafChildArrayFieldHandle.h