caffa Namespace Reference

Main Caffa namespace. More...

Classes
class	AppEnum
struct	PortableDataType< AppEnum< EnumType > >
struct	PortableDataType< std::vector< AppEnum< EnumType > > >
struct	JsonDataType< AppEnum< EnumType > >
struct	AppInfo
	Basic Application Information. More...
class	Application
class	FieldJsonCap
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	ChildFieldDirectStorageAccessor
class	ChildFieldBaseHandle
class	ChildFieldHandle
class	DataFieldAccessorInterface
	Basic non-typed interface which exists only to allow non-typed pointers. More...
class	DataFieldAccessor
	Abstract but typed data field accessor. Inherit to create different storage mechanisms. More...
class	DataFieldDirectStorageAccessor
	Direct storage accessor, which stores data values in local memory. More...
class	DefaultObjectFactory
class	Document
class	Factory
class	Field
class	FieldCapability
class	FieldDocumentationCapability
class	FieldHandle
	Base class for all fields, making it possible to handle them generically. More...
class	FieldJsonCapability
class	FieldJsonCap< ChildField< DataType * > >
class	FieldJsonCap< ChildArrayField< DataType * > >
class	SetValueInterface
class	SetterMethodCB
class	GetValueInterface
class	GetterMethodCB
class	FieldProxyAccessor
class	FieldScriptingCapability
class	FieldValidatorInterface
	An abstract field validator interface for validating field values. More...
class	FieldValidator
	Used to validate the value of data fields Implementations need the the validate method as well as readFromJson and writeToJson. More...
class	RangeValidator
	Simple range validator. More...
struct	JsonDataType
struct	JsonDataType< void >
struct	JsonDataType< std::vector< DataType > >
struct	JsonDataType< DataType >
struct	JsonDataType< bool >
struct	JsonDataType< std::string >
class	JsonSerializer
class	Method
class	Method< Result(ArgTypes...)>
class	MethodAccessorInterface
class	MethodHandle
class	FieldInitHelper
class	Object
class	ObjectAttribute
class	ObjectCapability
class	ConstObjectCollector
class	ObjectCollector
class	ObjectFactory
class	ObjectHandle
struct	is_shared_ptr
struct	is_shared_ptr< std::shared_ptr< T > >
struct	PortableDataType< DataType >
struct	PortableDataType< std::vector< DataType > >
class	ObjectPerformer
struct	PortableDataType
class	Serializer
class	Session
	Abstract class representing an application session. More...
class	SessionMaintainer
class	ConstSessionMaintainer
class	AbstractSignal
class	SignalEmitter
class	SignalObserver
class	Signal
struct	is_vector
struct	is_vector< std::vector< T, A > >
class	DataField
class	TypedField
class	UuidGenerator
class	Inspector
class	Editor

Functions
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)
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 AppInfo &appInfo)
void	from_json (const nlohmann::json &jsonValue, AppInfo &appInfo)
template<typename FieldType >
void	AddIoCapabilityToField (FieldType *field)
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)

Variables
string	name = "caffa"
	current_dir = os.path.abspath(os.curdir)
	caffa_dir = os.path.dirname(__file__)
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
template<typename T >
concept	IsVector = is_vector<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