SerializableObject Class Reference

The SerializableObject class is the base class for all classes which need to be serializable/deserializable from/to librepcb::SExpression nodes. More...

#include <serializableobject.h>

Inheritance diagram for SerializableObject:

Collaboration diagram for SerializableObject:

Public Member Functions
	SerializableObject () noexcept
virtual	~SerializableObject () noexcept
SExpression	serializeToDomElement (const QString &name) const
	Serialize the object to a new S-Expression node. More...
virtual void	serialize (SExpression &root) const =0
	Serialize the object into an existing S-Expression node. More...

Static Public Member Functions
template<typename T >
static void	serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
template<typename T >
static void	serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
template<typename T >
static void	serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)

Detailed Description

The SerializableObject class is the base class for all classes which need to be serializable/deserializable from/to librepcb::SExpression nodes.

Constructor & Destructor Documentation

SerializableObject()

SerializableObject ( )

inlinenoexcept

~SerializableObject()

virtual ~SerializableObject ( )

inlinevirtualnoexcept

Member Function Documentation

serializeToDomElement()

SExpression serializeToDomElement ( const QString &  name ) const

inline

Serialize the object to a new S-Expression node.

This method creates a new S-Expression node, serializes the whole object into it and then returns the whole S-Expression node. See serialize() for details.

Parameters

name	The root name of the returned S-Expression node

Returns

The created S-Expression node (the caller takes the ownership!)

Exceptions

Exception

This method throws an exception if an error occurs.

See also

serialize()

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

virtual void serialize ( SExpression &  root ) const

pure virtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note

The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).

Parameters

root	The target DOM root node

Exceptions

Exception

This method throws an exception if an error occurs.

Implemented in Point, SerializableObjectList< T, P, OnEditedArgs >, SerializableObjectList< ComponentPinSignalMapItem, ComponentPinSignalMapNameProvider, ComponentPinSignalMapItem::Event >, SerializableObjectList< StrokeText, StrokeTextListNameProvider, StrokeText::Event >, SerializableObjectList< Footprint, FootprintListNameProvider, OnEditedArgs... >, SerializableObjectList< Text, TextListNameProvider, Text::Event >, SerializableObjectList< ComponentSignal, ComponentSignalListNameProvider, OnEditedArgs... >, SerializableObjectList< ComponentSignal, ComponentSignalListNameProvider, ComponentSignal::Event >, SerializableObjectList< Polygon, PolygonListNameProvider, OnEditedArgs... >, SerializableObjectList< PackagePad, PackagePadListNameProvider, OnEditedArgs... >, SerializableObjectList< FootprintPad, FootprintPadListNameProvider, FootprintPad::Event >, SerializableObjectList< Attribute, AttributeListNameProvider, OnEditedArgs... >, SerializableObjectList< Hole, HoleListNameProvider, Hole::Event >, SerializableObjectList< StrokeText, StrokeTextListNameProvider, OnEditedArgs... >, SerializableObjectList< Text, TextListNameProvider, OnEditedArgs... >, SerializableObjectList< Footprint, FootprintListNameProvider, Footprint::Event >, SerializableObjectList< T, P, OnEditedArgs... >, SerializableObjectList< DevicePadSignalMapItem, DevicePadSignalMapNameProvider, OnEditedArgs... >, SerializableObjectList< Hole, HoleListNameProvider, OnEditedArgs... >, SerializableObjectList< ComponentSymbolVariant, ComponentSymbolVariantListNameProvider, ComponentSymbolVariant::Event >, SerializableObjectList< SymbolPin, SymbolPinListNameProvider, SymbolPin::Event >, SerializableObjectList< ComponentPinSignalMapItem, ComponentPinSignalMapNameProvider, OnEditedArgs... >, SerializableObjectList< ComponentSymbolVariant, ComponentSymbolVariantListNameProvider, OnEditedArgs... >, SerializableObjectList< Attribute, AttributeListNameProvider, Attribute::Event >, SerializableObjectList< FootprintPad, FootprintPadListNameProvider, OnEditedArgs... >, SerializableObjectList< ComponentSymbolVariantItem, ComponentSymbolVariantItemListNameProvider, OnEditedArgs... >, SerializableObjectList< Circle, CircleListNameProvider, OnEditedArgs... >, SerializableObjectList< SymbolPin, SymbolPinListNameProvider, OnEditedArgs... >, SerializableObjectList< ComponentSymbolVariantItem, ComponentSymbolVariantItemListNameProvider, ComponentSymbolVariantItem::Event >, SerializableObjectList< DevicePadSignalMapItem, DevicePadSignalMapNameProvider, DevicePadSignalMapItem::Event >, SerializableObjectList< PackagePad, PackagePadListNameProvider, PackagePad::Event >, SerializableObjectList< Circle, CircleListNameProvider, Circle::Event >, SerializableObjectList< Polygon, PolygonListNameProvider, Polygon::Event >, Board, Alignment, Schematic, StrokeText, SerializableKeyValueMap< T >, ComponentInstance, SerializableKeyValueMap< LocalizedKeywordsMapPolicy >, SerializableKeyValueMap< LocalizedNameMapPolicy >, SerializableKeyValueMap< NormDependentPrefixMapPolicy >, SerializableKeyValueMap< LocalizedDescriptionMapPolicy >, ProjectMetadata, Component, Circuit, BoardFabricationOutputSettings, BoardDesignRules, LibraryBaseElement, ComponentSignalInstance, Symbol, FootprintPad, Footprint, SI_NetSegment, NetSignal, ComponentSymbolVariant, BI_NetLine, BI_NetSegment, BI_Plane, ComponentSymbolVariantItem, BI_Device, FootprintClipboardData, SI_Symbol, Device, BI_Footprint, ComponentSignal, SymbolPin, BI_Via, SI_NetLine, Path, Text, ComponentPinSignalMapItem, Library, Circle, Polygon, Package, SymbolClipboardData, WorkspaceSettings, BoardLayerStack, Attribute, NetClass, ProjectSettings, BI_Polygon, BI_StrokeText, PackagePad, BI_NetPoint, ErcMsgList, SI_NetLabel, SI_NetPoint, LibraryCategory, LibraryElement, Hole, DevicePadSignalMapItem, BI_Hole, GridProperties, Vertex, BoardUserSettings, and GraphicsLayerStackAppearanceSettings.

Here is the caller graph for this function:

serializeObjectContainer()

static void serializeObjectContainer ( SExpression &  root, const T &  container, const QString &  itemName  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

serializePointerContainer()

static void serializePointerContainer ( SExpression &  root, const T &  container, const QString &  itemName  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

serializePointerContainerUuidSorted()

static void serializePointerContainerUuidSorted ( SExpression &  root, const T &  container, const QString &  itemName  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• /__w/1/s/libs/librepcb/common/fileio/serializableobject.h