ecstasy::serialization::EntityComponentSerializer< Component, Serializer > Class Template Reference

Entity component serializer class bound to a specific component and a serializer type. More...

#include <EntityComponentSerializer.hpp>

Inheritance diagram for ecstasy::serialization::EntityComponentSerializer< Component, Serializer >:

Collaboration diagram for ecstasy::serialization::EntityComponentSerializer< Component, Serializer >:

Public Types
using	StorageType = getStorageType< Component >
	Type of the storage used to store the component.

Public Member Functions
	EntityComponentSerializer () noexcept
	Construct a new Component Rtti.
	~EntityComponentSerializer () noexcept override=default
	Destroy the Component Rtti.
ISerializer &	save (ISerializer &serializer, const IStorage &storage, const RegistryEntity &entity) const override final
	Save the component to the serializer.
ISerializer &	load (ISerializer &serializer, IStorage &storage, RegistryEntity &entity) const override final
	Load an entity component from the serializer.
const std::type_info &	getType () const noexcept override final
	Get the type info of the component.
Public Member Functions inherited from ecstasy::serialization::IEntityComponentSerializer
virtual	~IEntityComponentSerializer () noexcept=default
	Destroy the IEntityComponentSerializer.
virtual ISerializer &	save (ISerializer &serializer, const IStorage &storage, const RegistryEntity &entity) const =0
	Save the component to the serializer.
virtual ISerializer &	load (ISerializer &serializer, IStorage &storage, RegistryEntity &entity) const =0
	Load an entity component from the serializer.
virtual const std::type_info &	getType () const noexcept=0
	Get the type info of the component.

Detailed Description

template<typename Component, std::derived_from< ISerializer > Serializer>
class ecstasy::serialization::EntityComponentSerializer< Component, Serializer >

Entity component serializer class bound to a specific component and a serializer type.

The class instance doesn't contains any data except its vtable.

Template Parameters

Component	Type of the component to serialize.
Serializer	Type of the serializer to use to serialize the component.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-04)

Definition at line 33 of file EntityComponentSerializer.hpp.

Member Typedef Documentation

StorageType

template<typename Component , std::derived_from< ISerializer > Serializer>

using ecstasy::serialization::EntityComponentSerializer< Component, Serializer >::StorageType = getStorageType<Component>

Type of the storage used to store the component.

Definition at line 36 of file EntityComponentSerializer.hpp.

Constructor & Destructor Documentation

EntityComponentSerializer()

template<typename Component , std::derived_from< ISerializer > Serializer>

ecstasy::serialization::EntityComponentSerializer< Component, Serializer >::EntityComponentSerializer ( )

inlinenoexcept

Construct a new Component Rtti.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-04)

Definition at line 44 of file EntityComponentSerializer.hpp.

                                             : IEntityComponentSerializer()
        {
        }

~EntityComponentSerializer()

template<typename Component , std::derived_from< ISerializer > Serializer>

ecstasy::serialization::EntityComponentSerializer< Component, Serializer >::~EntityComponentSerializer ( )

overridedefaultnoexcept

Destroy the Component Rtti.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-04)

Member Function Documentation

getType()

template<typename Component , std::derived_from< ISerializer > Serializer>

const std::type_info & ecstasy::serialization::EntityComponentSerializer< Component, Serializer >::getType ( ) const

inlinefinaloverridevirtualnoexcept

Get the type info of the component.

Returns

const std::type_info& Reference to the type info of the component.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-25)

Implements ecstasy::serialization::IEntityComponentSerializer.

Definition at line 77 of file EntityComponentSerializer.hpp.

        {
            return typeid(Component);
        }

load()

template<typename Component , std::derived_from< ISerializer > Serializer>

ISerializer & ecstasy::serialization::EntityComponentSerializer< Component, Serializer >::load ( ISerializer &  serializer, IStorage &  storage, RegistryEntity &  entity  ) const

inlinefinaloverridevirtual

Load an entity component from the serializer.

Parameters

[in]	serializer	Reference to the serializer to load the component from.
[in]	storage	Reference to the storage to load the component to.
[in]	entity	Reference to the entity to load/update the component to.

Returns

ISerializer& Reference to the serializer for chaining.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-04)

Implements ecstasy::serialization::IEntityComponentSerializer.

Definition at line 65 of file EntityComponentSerializer.hpp.

        {
            if (!storage.contains(entity.getIndex())) {
                dynamic_cast<StorageType &>(storage).insert(
                    entity.getIndex(), dynamic_cast<Serializer &>(serializer).template load<Component>());
                return serializer;
            } else
                return dynamic_cast<Serializer &>(serializer)
                    .template update<Component>(dynamic_cast<StorageType &>(storage).at(entity.getIndex()));
        }

save()

template<typename Component , std::derived_from< ISerializer > Serializer>

ISerializer & ecstasy::serialization::EntityComponentSerializer< Component, Serializer >::save ( ISerializer &  serializer, const IStorage &  storage, const RegistryEntity &  entity  ) const

inlinefinaloverridevirtual

Save the component to the serializer.

Parameters

[in]	serializer	Reference to the serializer to save the component to.
[in]	storage	Const reference to the storage containing the component.
[in]	entity	Const reference to the entity associated with the component.

Returns

ISerializer& Reference to the serializer for chaining.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-04)

Implements ecstasy::serialization::IEntityComponentSerializer.

Definition at line 56 of file EntityComponentSerializer.hpp.

        {
            return dynamic_cast<Serializer &>(serializer)
                .template saveEntityComponent<Component>(
                    dynamic_cast<const StorageType &>(storage).at(entity.getIndex()));
        }

---

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

• src/ecstasy/serialization/EntityComponentSerializer.hpp