serializer.h File Reference

#include "json_serializer.h"
#include "datapack_serializer.h"
#include "fpmas/io/json_datapack.h"

Include dependency graph for serializer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	fpmas

Macros
#define	FPMAS_AGENT_PTR_DATAPACK_JSON_FALLBACK()
#define	FPMAS_AGENT_PTR_JSON_DATAPACK_FALLBACK()
#define	FPMAS_JSON_SET_UP(...)
#define	FPMAS_DEFAULT_JSON_SET_UP()
#define	FPMAS_DATAPACK_SET_UP(...)
#define	FPMAS_DEFAULT_DATAPACK_SET_UP()
#define	FPMAS_REGISTER_AGENT_TYPES(...)    fpmas::register_types<__VA_ARGS__ , void>();

Functions
template<typename _T , typename... T>
void	fpmas::register_types ()
template<>
void	fpmas::register_types< void > ()

Detailed Description

Agent serialization related objects.

Macro Definition Documentation

FPMAS_AGENT_PTR_DATAPACK_JSON_FALLBACK

#define FPMAS_AGENT_PTR_DATAPACK_JSON_FALLBACK

(

)

Value:

    namespace fpmas { namespace io { namespace datapack {\
        std::size_t Serializer<AgentPtr>::size(const ObjectPack& p, const AgentPtr& ptr) {\
            return JsonSerializer<AgentPtr>::size(p, ptr);\
        }\
        void Serializer<AgentPtr>::to_datapack(ObjectPack& p, const AgentPtr& ptr) {\
            JsonSerializer<AgentPtr>::to_datapack(p, ptr);\
        }\
        AgentPtr Serializer<AgentPtr>::from_datapack(const ObjectPack& p) {\
            return JsonSerializer<AgentPtr>::from_datapack(p);\
        }\
        std::size_t LightSerializer<AgentPtr>::size(const LightObjectPack& p, const AgentPtr& ptr) {\
            return LightJsonSerializer<AgentPtr>::size(p, ptr);\
        }\
        void LightSerializer<AgentPtr>::to_datapack(LightObjectPack& p, const AgentPtr& ptr) {\
            LightJsonSerializer<AgentPtr>::to_datapack(p, ptr);\
        }\
        AgentPtr LightSerializer<AgentPtr>::from_datapack(const LightObjectPack& p) {\
            return LightJsonSerializer<AgentPtr>::from_datapack(p);\
        }\
    }}}

Defines a json based implementation of AgentPtr fpmas::io::datapack::Serializer and fpmas::io::datapack::LightSerializer implementation, that can be used instead of definitions provided by FPMAS_BASE_DATAPACK_SET_UP().

This allows to use the object pack serialization for DistributedNodes for example, even if ObjectPack serialization rules are not provided for AgentPtr (i.e. FPMAS_BASE_DATAPACK_SET_UP() is not used).

FPMAS_AGENT_PTR_JSON_DATAPACK_FALLBACK

#define FPMAS_AGENT_PTR_JSON_DATAPACK_FALLBACK

(

)

Value:

    namespace nlohmann {\
        void adl_serializer<fpmas::api::model::AgentPtr>\
        ::to_json(json& j, const fpmas::api::model::AgentPtr& ptr) {\
            fpmas::io::json::datapack_serializer<fpmas::api::model::AgentPtr>\
            ::to_json(j, ptr);\
        }\
        fpmas::api::model::AgentPtr adl_serializer<fpmas::api::model::AgentPtr>\
        ::from_json(const json& j) {\
            return fpmas::io::json::datapack_serializer<fpmas::api::model::AgentPtr>\
			::from_json(j);\
        }\
    }\
    namespace fpmas { namespace io { namespace json {\
        void light_serializer<api::model::AgentPtr>\
        ::to_json(light_json& j, const api::model::AgentPtr& ptr) {\
            fpmas::io::json::light_datapack_serializer<api::model::AgentPtr>\
            ::to_json(j, ptr);\
        }\
        api::model::AgentPtr light_serializer<api::model::AgentPtr>\
        ::from_json(const light_json& j) {\
            return fpmas::io::json::light_datapack_serializer<api::model::AgentPtr>\
			::from_json(j);\
        }\
    }}}

Defines an object pack based implementation of AgentPtr nlohmann::adl_serializer and fpmas::io::json::light_serializer implementation, that can be used instead of definitions provided by FPMAS_BASE_JSON_SET_UP().

This allows to use the json serialization for DistributedNodes for example, even if JSON serialization rules are not provided for AgentPtr (i.e. FPMAS_BASE_JSON_SET_UP() is not used).

FPMAS_JSON_SET_UP

#define FPMAS_JSON_SET_UP

(

...

)

Value:

    FPMAS_BASE_JSON_SET_UP(__VA_ARGS__)\
    FPMAS_AGENT_PTR_DATAPACK_JSON_FALLBACK()

Sets up json based Agent serialization rules.

This macro must be invoked exactly once from a source file and should not be called together with FPMAS_DATAPACK_SET_UP().

It is possible to call the FPMAS_DEFAULT_JSON_SET_UP() macro to set up the JSON serialization without specifying any Agent.

The same set of Agent types must be registered at runtime using the FPMAS_REGISTER_AGENT_TYPES(...) macro at runtime.

Example

#define AGENT_TYPES Agent1, Agent2, OtherAgent
 
FPMAS_JSON_SET_UP(AGENT_TYPES)
 
int main(int argc, char** argv) {
    FPMAS_REGISTER_AGENT_TYPES(AGENT_TYPES);
 
    fpmas::init(argc, argv);
 
    ...
 
    fpmas::finalize();
}

ObjectPack Agent serialization is set up so that Agent are serialized into JSON, stored in an ObjectPack field. To prevent this behavior, FPMAS_BASE_JSON_SET_UP() and FPMAS_BASE_DATAPACK_SET_UP() can be used together to enable both Agent serialization techniques.

Notice that all of this only affect AgentPtr serialization: serialization of any other object, with JSON or ObjectPack, is not altered by those macros.

See the nlohmann::adl_serializer<fpmas::api::utils::PtrWrapper<AgentType>> documentation to learn how to enable Agent datapack serialization.

FPMAS_DEFAULT_JSON_SET_UP

#define FPMAS_DEFAULT_JSON_SET_UP

(

)

Value:

    FPMAS_BASE_DEFAULT_JSON_SET_UP()\
    FPMAS_BASE_DEFAULT_DATAPACK_SET_UP()

Can be used instead of FPMAS_JSON_SET_UP() to set up json serialization without specifying any Agent type.

FPMAS_DATAPACK_SET_UP

#define FPMAS_DATAPACK_SET_UP

(

...

)

Value:

    FPMAS_BASE_DATAPACK_SET_UP(__VA_ARGS__)\
    FPMAS_AGENT_PTR_JSON_DATAPACK_FALLBACK()

Sets up object pack based Agent serialization rules.

This macro must be invoked exactly once from a source file and should not be called together with FPMAS_JSON_SET_UP().

It is possible to call the FPMAS_DEFAULT_DATAPACK_SET_UP() macro to set up the object pack serialization without specifying any Agent.

The same set of Agent types must be registered at runtime using the FPMAS_REGISTER_AGENT_TYPES(...) macro at runtime.

Example

#define AGENT_TYPES Agent1, Agent2, OtherAgent
 
FPMAS_DATAPACK_SET_UP(AGENT_TYPES)
 
int main(int argc, char** argv) {
    FPMAS_REGISTER_AGENT_TYPES(AGENT_TYPES);
 
    fpmas::init(argc, argv);
 
    ...
 
    fpmas::finalize();
}

ObjectPack Agent serialization is set up so that Agent are serialized into JSON, stored in an ObjectPack field. To prevent this behavior, FPMAS_BASE_JSON_SET_UP() and FPMAS_BASE_DATAPACK_SET_UP() can be used together to enable both Agent serialization techniques.

Notice that all of this only affect AgentPtr serialization: serialization of any other object, with JSON or ObjectPack, is not altered by those macros.

See the fpmas::io::datapack::Serializer<api::utils::PtrWrapper<AgentType>> documentation to learn how to enable Agent datapack serialization.

FPMAS_DEFAULT_DATAPACK_SET_UP

#define FPMAS_DEFAULT_DATAPACK_SET_UP

(

)

Value:

    FPMAS_BASE_DEFAULT_DATAPACK_SET_UP()\
    FPMAS_BASE_DEFAULT_JSON_SET_UP()

Can be used instead of FPMAS_DATAPACK_SET_UP() to set up object pack serialization without specifying any Agent type.

FPMAS_REGISTER_AGENT_TYPES

#define FPMAS_REGISTER_AGENT_TYPES

(

...

)

fpmas::register_types<__VA_ARGS__ , void>();

Registers the specified Agent types so that they can be serialized as JSON using the nlohmann library.

More particularly, registers Agents types so that their TypeId (i.e. their corresponding std::type_index) can be serialized. Serialization rules (to_json and from_json methods) for each type must still be specified.

This macro must be called at runtime, as soon as possible, before any Agent serialization occurs.

Example

...
 
int main(int argc, char** argv) {
    fpmas::init(argc, argv);
 
    FPMAS_REGISTER_AGENT_TYPES(Agent1, Agent2, OtherAgent);
 
    ...
 
    fpmas::finalize();
}