Caffa  1.1.0
C++ Application Framework for Embedded Systems with introspection
Public Types | Public Member Functions | Friends | List of all members
caffa::ChildField< DataTypePtr > Class Template Reference

Field class to handle a pointer to a caffa Object. More...

#include <cafChildField.h>

Inheritance diagram for caffa::ChildField< DataTypePtr >:
Inheritance graph
[legend]
Collaboration diagram for caffa::ChildField< DataTypePtr >:
Collaboration graph
[legend]

Public Types

using DataType = typename std::remove_pointer< DataTypePtr >::type
 
using Ptr = std::shared_ptr< DataType >
 
using ConstPtr = std::shared_ptr< const DataType >
 
using FieldDataType = DataTypePtr
 

Public Member Functions

ChildFieldoperator= (Ptr object)
 
bool operator== (ObjectHandle::ConstPtr object) const
 
bool operator== (const ObjectHandle *object) const
 
std::shared_ptr< DataType > object ()
 
std::shared_ptr< const DataType > object () const
 
void setObject (Ptr object)
 
 operator std::shared_ptr< DataType > ()
 
 operator std::shared_ptr< const DataType > () const
 
 operator bool () const
 
std::shared_ptr< DataType > deepCloneObject () const
 
void deepCopyObjectFrom (std::shared_ptr< const DataType > copyFrom)
 
std::shared_ptr< DataType > operator-> ()
 
std::shared_ptr< const DataType > operator-> () const
 
std::shared_ptr< DataType > operator() ()
 
std::shared_ptr< const DataType > operator() () const
 
std::vector< ObjectHandle::Ptr > childObjects () override
 
std::vector< ObjectHandle::ConstPtr > childObjects () const override
 
void clear () override
 
void removeChildObject (ObjectHandle::ConstPtr object)
 
void setChildObject (ObjectHandle::Ptr object)
 
std::string dataType () const override
 
void setAccessor (std::unique_ptr< ChildFieldAccessor > accessor) override
 
std::string childClassKeyword () const override
 Get the class keyword of the contained child(ren)
 
- Public Member Functions inherited from caffa::ChildFieldBaseHandle
void accept (Inspector *visitor) const override
 
void accept (Editor *visitor) override
 
- Public Member Functions inherited from caffa::FieldHandle
std::string keyword () const override
 
ObjectHandleownerObject ()
 
void addCapability (std::unique_ptr< FieldCapability > capability)
 
template<typename CapabilityType >
CapabilityType * capability ()
 
template<typename CapabilityType >
const CapabilityType * capability () const
 
- Public Member Functions inherited from caffa::SignalEmitter
void addEmittedSignal (AbstractSignal *signalToAdd) const
 
std::list< AbstractSignal * > emittedSignals () const
 

Friends

class FieldJsonCap< ChildField< DataType * > >
 

Additional Inherited Members

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

Detailed Description

template<typename DataTypePtr>
class caffa::ChildField< DataTypePtr >

Field class to handle a pointer to a caffa Object.

Template Parameters
DataTypePtrA pointer to a class derived from caffa::Object

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