Caffa  1.1.0
C++ Application Framework for Embedded Systems with introspection
Public Member Functions | List of all members
caffa::Document Class Reference

#include <cafDocument.h>

Inheritance diagram for caffa::Document:
Inheritance graph
[legend]
Collaboration diagram for caffa::Document:
Collaboration graph
[legend]

Public Member Functions

 Document (const std::string &id=std::string(classKeywordStatic()))
 
std::string id () const
 
std::string fileName () const
 
void setId (const std::string &id)
 
void setFileName (const std::string &fileName)
 
- Public Member Functions inherited from caffa::Object
 Object (bool generateUuid=true)
 
- Public Member Functions inherited from caffa::ObjectHandle
 ObjectHandle (bool generateUuid=true)
 
virtual std::string classKeyword () const
 
virtual InheritanceStackType classInheritanceStack () const
 
std::string parentClassKeyword () const
 Get the parent class keyword. More...
 
virtual std::string classDocumentation () const
 
std::vector< FieldHandle * > fields () const
 
std::vector< MethodHandle * > methods () const
 
FieldHandlefindField (const std::string &keyword) const
 
MethodHandlefindMethod (const std::string &keyword) const
 
const std::string & uuid () const
 
void setUuid (const std::string &)
 
virtual void initAfterRead ()
 
void accept (Inspector *visitor) const
 
void accept (Editor *editor)
 

Additional Inherited Members

- Public Types inherited from caffa::ObjectHandle
using InheritanceStackType = std::vector< std::string >
 
- Static Public Member Functions inherited from caffa::ObjectHandle
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 inherited from caffa::Object
template<typename FieldType >
FieldInitHelper< FieldType > initField (FieldType &field, const std::string &keyword)
 
template<typename MethodType , typename CallbackT >
MethodInitHelper< MethodType > initMethod (MethodType &method, const std::string &keyword, CallbackT &&callback)
 
template<typename MethodType , typename CallbackT >
MethodInitHelper< MethodType > initMethodWithSession (MethodType &method, const std::string &keyword, CallbackT &&callback)
 
- Protected Member Functions inherited from caffa::ObjectHandle
void addField (FieldHandle *field, const std::string &keyword)
 
void addMethod (MethodHandle *method, const std::string &keyword)
 

Detailed Description

The Document class is the main class to do file based IO, and is also supposed to act as the overall container of the objects read.


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