caffa Namespace Reference

Main Caffa namespace. More...

Classes
class	AbstractSignal
class	AppEnum
struct	AppInfo
	Basic Application Information. More...
class	Application
class	ChildArrayField
	Field class to handle a collection of Object derived pointers The ChildArrayField will take over ownership of any object assigned to it. More...
class	ChildArrayFieldAccessor
class	ChildArrayFieldDirectStorageAccessor
class	ChildArrayFieldHandle
	A non-templated base interface for ChildArrayField<DataType*> Used so we can have pointers to any ChildArrayField. More...
class	ChildField
	Field class to handle a pointer to a caffa Object. More...
class	ChildFieldAccessor
class	ChildFieldBaseHandle
class	ChildFieldDirectStorageAccessor
class	ChildFieldHandle
class	ConstObjectCollector
class	ConstSessionMaintainer
class	DataField
class	DataFieldAccessor
	Abstract but typed data field accessor. Inherit to create different storage mechanisms. More...
class	DataFieldAccessorInterface
	Basic non-typed interface which exists only to allow non-typed pointers. More...
class	DataFieldDirectStorageAccessor
	Direct storage accessor, which stores data values in local memory. More...
class	DefaultObjectFactory
class	Document
class	Editor
class	Field
class	FieldCapability
class	FieldHandle
	Base class for all fields, making it possible to handle them generically. More...
class	FieldInitHelper
class	FieldJsonCap
class	FieldJsonCap< ChildArrayField< DataType * > >
class	FieldJsonCap< ChildField< DataType * > >
class	FieldJsonCapability
class	FieldProxyAccessor
class	FieldScriptingCapability
class	FieldValidator
	Used to validate the value of data fields Implementations need the the validate method as well as readFromString and writeToString. More...
class	FieldValidatorInterface
	An abstract field validator interface for validating field values. More...
class	GetterMethodCB
class	GetValueInterface
class	Inspector
struct	is_chrono_integral
struct	is_chrono_integral< std::chrono::duration< Rep, Period > >
struct	is_chrono_integral< std::chrono::time_point< Clock, Duration > >
struct	is_shared_ptr
struct	is_shared_ptr< std::shared_ptr< T > >
struct	JsonDataType
struct	JsonDataType< AppEnum< EnumType > >
struct	JsonDataType< DataType >
struct	JsonDataType< std::vector< DataType > >
struct	JsonDataType< void >
class	JsonSerializer
class	Method
class	Method< Result(ArgTypes...)>
class	MethodAccessorInterface
class	MethodHandle
class	MethodInitHelper
class	Object
class	ObjectCollector
class	ObjectFactory
class	ObjectHandle
class	ObjectPerformer
struct	PortableDataType
struct	PortableDataType< AppEnum< EnumType > >
struct	PortableDataType< bool >
struct	PortableDataType< DataType >
struct	PortableDataType< double >
struct	PortableDataType< float >
struct	PortableDataType< std::chrono::microseconds >
struct	PortableDataType< std::chrono::milliseconds >
struct	PortableDataType< std::chrono::nanoseconds >
struct	PortableDataType< std::chrono::seconds >
struct	PortableDataType< std::chrono::steady_clock::time_point >
struct	PortableDataType< std::string >
struct	PortableDataType< std::vector< DataType > >
struct	PortableDataType< void >
class	RangeValidator
	Simple range validator. More...
class	RestServiceFactory
class	Session
	Abstract class representing an application session. More...
class	SessionMaintainer
class	SetterMethodCB
class	SetValueInterface
class	Signal
class	SignalEmitter
class	SignalObserver
class	TypedField

Functions
void	to_json (nlohmann::json &jsonValue, const AppInfo &appInfo)
void	from_json (const nlohmann::json &jsonValue, AppInfo &appInfo)
template<typename FieldType >
void	AddIoCapabilityToField (FieldType *field)
template<typename Enum >
void	to_json (nlohmann::json &jsonValue, const AppEnum< Enum > &appEnum)
template<typename Enum >
void	from_json (const nlohmann::json &jsonValue, AppEnum< Enum > &appEnum)
void	to_json (nlohmann::json &jsonValue, const ObjectHandle &object)
void	from_json (const nlohmann::json &jsonValue, ObjectHandle &object)
void	to_json (nlohmann::json &jsonValue, std::shared_ptr< const ObjectHandle > object)
void	from_json (const nlohmann::json &jsonValue, std::shared_ptr< ObjectHandle > object)
template<typename Enum >
std::istream &	operator>> (std::istream &str, caffa::AppEnum< Enum > &appEnum)
template<typename Enum >
std::ostream &	operator<< (std::ostream &str, const caffa::AppEnum< Enum > &appEnum)

Variables
template<typename T >
concept	DerivesFromFieldHandle = std::is_base_of<FieldHandle, T>::value
template<typename _Tp >
concept	chrono_integral = is_chrono_integral<_Tp>::value
template<typename _Tp >
concept	supported_integral = ( std::integral<_Tp> || chrono_integral<_Tp> ) && !std::is_same<_Tp, bool>::value
template<typename MethodType >
concept	DerivesFromMethodHandle = std::is_base_of<MethodHandle, MethodType>::value
template<typename T >
concept	enum_type = std::is_enum<T>::value
template<typename DataTypePtr >
concept	is_pointer = std::is_pointer<DataTypePtr>::value
template<typename T >
concept	DerivesFromObjectHandle = std::is_base_of<ObjectHandle, T>::value
template<typename T >
concept	IsSharedPtr = is_shared_ptr<T>::value

Detailed Description

Main Caffa namespace.

Function Documentation

operator>>()

template<typename Enum >

std::istream& caffa::operator>>	(	std::istream &	str,
		caffa::AppEnum< Enum > &	appEnum
	)

Implementation of stream operators to make Field<AppEnum<> > work smoothly Assumes that the stream ends at the end of the enum label