ot::Serializable Class Reference

The Serializable class is the default interface of serializable objects. More...

#include "Serializable.h"

Inheritance diagram for ot::Serializable:

Public Member Functions
	Serializable ()
virtual	~Serializable ()
virtual void	addToJsonObject (ot::JsonValue &_object, ot::JsonAllocator &_allocator) const =0
	Add the object contents to the provided JSON object.
virtual void	setFromJsonObject (const ot::ConstJsonObject &_object)=0
	Set the object contents from the provided JSON object.

Detailed Description

The Serializable class is the default interface of serializable objects.

Constructor & Destructor Documentation

Serializable()

ot::Serializable::Serializable ( )

inline

~Serializable()

virtual ot::Serializable::~Serializable ( )

inlinevirtual

Member Function Documentation

addToJsonObject()

virtual void ot::Serializable::addToJsonObject ( ot::JsonValue & _object, ot::JsonAllocator & _allocator ) const

pure virtual

Add the object contents to the provided JSON object.

Parameters

_object	Json object reference to write the data to.
_allocator	Allocator.

Implemented in ot::BasicEntityInformation, ot::CopyInformation, ot::Rect, ot::RectF, ot::RectD, ot::ReturnValues, ot::CheckBoxCfg, ot::DialogCfg, ot::GraphicsCopyInformation, ot::Grid, ot::LineEditCfg, ot::MenuButtonCfg, ot::MenuCfg, ot::MenuClickableEntryCfg, ot::MenuEntryCfg, ot::MessageDialogCfg, ot::NavigationTreeItem, ot::NavigationTreeItemIcon, ot::NavigationTreePackage, ot::OnePropertyDialogCfg, ot::Outline, ot::OutlineF, ot::Path2D, ot::Path2DF, ot::Plot1DAxisCfg, ot::Plot1DCfg, ot::Plot1DCurveInfoCfg, ot::Plot1DDataBaseCfg, ot::ProjectTemplateInformation, ot::Property, ot::PropertyBase, ot::PropertyDialogCfg, ot::PropertyGridCfg, ot::PropertyGroup, ot::SelectEntitiesDialogCfg, ot::StyledTextBuilder, ot::StyledTextEntry, ot::StyledTextStyle, ot::SyntaxHighlighterRule, ot::TableCfg, ot::TableHeaderItemCfg, ot::TextEditorCfg, ot::ToolButtonCfg, ot::Transform, ot::VersionGraphCfg, ot::VersionGraphVersionCfg, ot::VisualisationTypes, ot::WidgetBaseCfg, ot::WidgetViewBase, ot::ColorStyle, ot::ColorStyleValue, LocalSessionService, Configuration, ServiceInformation, and SessionInformation.

setFromJsonObject()

virtual void ot::Serializable::setFromJsonObject ( const ot::ConstJsonObject & _object )

pure virtual

Set the object contents from the provided JSON object.

Parameters

_object

The JSON object containing the information.

Exceptions

May	throw an exception if the provided object is not valid (members missing or invalid types).

Implemented in ot::BasicServiceInformation, ot::Color, ot::ColorF, ot::LogMessage, ot::Point2D, ot::Point2DF, ot::Point2DD, ot::ReturnMessage, ot::Size2D, ot::Size2DF, ot::Size2DD, ot::UIDNamePair, ot::Border, ot::BorderF, ot::CheckerboardPainter2D, ot::FillPainter2D, ot::Font, ot::GradientPainter2D, ot::GradientPainterStop2D, ot::GraphicsArcItemCfg, ot::GraphicsBoxLayoutItemCfg, ot::GraphicsConnectionCfg, ot::GraphicsEllipseItemCfg, ot::GraphicsGridLayoutItemCfg, ot::GraphicsGroupItemCfg, ot::GraphicsImageItemCfg, ot::GraphicsInvisibleItemCfg, ot::GraphicsItemCfg, ot::GraphicsItemFileCfg, ot::GraphicsLayoutItemCfg, ot::GraphicsLineItemCfg, ot::GraphicsPickerCollectionPackage, ot::GraphicsNewEditorPackage, ot::GraphicsScenePackage, ot::GraphicsConnectionPackage, ot::GraphicsPickerCollectionCfg, ot::GraphicsPickerItemInformation, ot::GraphicsPolygonItemCfg, ot::GraphicsRectangularItemCfg, ot::GraphicsShapeItemCfg, ot::GraphicsStackItemCfg, ot::GraphicsTextItemCfg, ot::GraphicsTriangleItemCfg, ot::LinearGradientPainter2D, ot::Margins, ot::MarginsF, ot::MarginsD, ot::Painter2D, ot::RadialGradientPainter2D, ot::StyleRefPainter2D, ot::StyleValue, ot::TableRange, ot::BasicEntityInformation, ot::CopyInformation, ot::Rect, ot::RectF, ot::RectD, ot::ReturnValues, ot::CheckBoxCfg, ot::DialogCfg, ot::GraphicsCopyInformation, ot::Grid, ot::LineEditCfg, ot::MenuButtonCfg, ot::MenuCfg, ot::MenuClickableEntryCfg, ot::MenuEntryCfg, ot::MessageDialogCfg, ot::NavigationTreeItem, ot::NavigationTreeItemIcon, ot::NavigationTreePackage, ot::OnePropertyDialogCfg, ot::Outline, ot::OutlineF, ot::Path2D, ot::Path2DF, ot::Plot1DAxisCfg, ot::Plot1DCfg, ot::Plot1DCurveInfoCfg, ot::Plot1DDataBaseCfg, ot::ProjectTemplateInformation, ot::Property, ot::PropertyBase, ot::PropertyDialogCfg, ot::PropertyGridCfg, ot::PropertyGroup, ot::SelectEntitiesDialogCfg, ot::StyledTextBuilder, ot::StyledTextEntry, ot::StyledTextStyle, ot::SyntaxHighlighterRule, ot::TableCfg, ot::TableHeaderItemCfg, ot::TextEditorCfg, ot::ToolButtonCfg, ot::Transform, ot::VersionGraphCfg, ot::VersionGraphVersionCfg, ot::VisualisationTypes, ot::WidgetBaseCfg, ot::WidgetViewBase, ot::ColorStyle, ot::ColorStyleValue, LocalSessionService, Configuration, ServiceInformation, and SessionInformation.

---

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

• Libraries/OTCore/include/OTCore/Serializable.h