meshXCompositionBuilder Class Reference

Fluent API for building the mesh composition. More...

#include <meshx_composition_builder.hpp>

Public Member Functions
	meshXCompositionBuilder ()=default
meshXCompositionBuilder &	begin ()
	Start building the composition.
meshXCompositionBuilder &	add_relay_server ()
	Add a Relay Server element.
meshXCompositionBuilder &	add_relay_client ()
	Add a Relay Client element.
meshXCompositionBuilder &	add_cwww_server ()
	Add a Light CWWW Server element.
meshXCompositionBuilder &	add_cwww_client ()
	Add a Light CWWW Client element.
meshXCompositionBuilder &	add_sensor_server ()
	Add a Sensor Server element.
meshXCompositionBuilder &	add_rgb_server ()
	Add an RGB (HSL) Server element.
meshXCompositionBuilder &	commit ()
	Commit the composition (Triggers Baking).

Detailed Description

Fluent API for building the mesh composition.

Constructor & Destructor Documentation

meshXCompositionBuilder()

meshXCompositionBuilder::meshXCompositionBuilder ( )

default

Member Function Documentation

add_cwww_client()

meshXCompositionBuilder & meshXCompositionBuilder::add_cwww_client

(

)

Add a Light CWWW Client element.

Returns

Reference to the builder

                                                                  {
#if CONFIG_LIGHT_CWWW_CLIENT_COUNT > 0
    auto& comp = meshXComposition::get_instance();
    uint16_t next_idx = (uint16_t)(comp.get_elements().size());
    comp.get_elements().push_back(std::make_unique<meshXCWWWClientElement>(next_idx));
#endif
    return *this;
}

add_cwww_server()

meshXCompositionBuilder & meshXCompositionBuilder::add_cwww_server

(

)

Add a Light CWWW Server element.

Returns

Reference to the builder

                                                                  {
#if CONFIG_LIGHT_CWWW_SRV_COUNT > 0
    auto& comp = meshXComposition::get_instance();
    uint16_t next_idx = (uint16_t)(comp.get_elements().size());
    comp.get_elements().push_back(std::make_unique<meshXCWWWServerElement>(next_idx));
#endif
    return *this;
}

add_relay_client()

meshXCompositionBuilder & meshXCompositionBuilder::add_relay_client

(

)

Add a Relay Client element.

Returns

Reference to the builder

                                                                   {
#if CONFIG_RELAY_CLIENT_COUNT > 0
    auto& comp = meshXComposition::get_instance();
    uint16_t next_idx = (uint16_t)(comp.get_elements().size());
    comp.get_elements().push_back(std::make_unique<meshXRelayClientElement>(next_idx));
#endif
    return *this;
}

add_relay_server()

meshXCompositionBuilder & meshXCompositionBuilder::add_relay_server

(

)

Add a Relay Server element.

Returns

Reference to the builder

                                                                   {
#if CONFIG_RELAY_SERVER_COUNT > 0
    auto& comp = meshXComposition::get_instance();
    uint16_t next_idx = (uint16_t)(comp.get_elements().size());
    comp.get_elements().push_back(std::make_unique<meshXRelayServerElement>(next_idx));
#endif
    return *this;
}

add_rgb_server()

meshXCompositionBuilder & meshXCompositionBuilder::add_rgb_server

(

)

Add an RGB (HSL) Server element.

Returns

Reference to the builder

                                                                 {
#if CONFIG_RGB_SERVER_COUNT > 0
    auto& comp = meshXComposition::get_instance();
    uint16_t next_idx = (uint16_t)(comp.get_elements().size());
    comp.get_elements().push_back(std::make_unique<meshXRGBServerElement>(next_idx));
#endif
    return *this;
}

add_sensor_server()

meshXCompositionBuilder & meshXCompositionBuilder::add_sensor_server

(

)

Add a Sensor Server element.

Returns

Reference to the builder

                                                                    {
#if CONFIG_SENSOR_SERVER_COUNT > 0
    auto& comp = meshXComposition::get_instance();
    uint16_t next_idx = (uint16_t)(comp.get_elements().size());
    comp.get_elements().push_back(std::make_unique<meshXSensorElement>(next_idx));
#endif
    return *this;
}

begin()

meshXCompositionBuilder & meshXCompositionBuilder::begin

(

)

Start building the composition.

Fluent API Implementation.

Returns

Reference to the builder

                                                        {
    auto& comp = meshXComposition::get_instance();
    comp.clear_elements();
 
    // All compositions must start with a Root Element at Index 0
    comp.get_elements().push_back(std::make_unique<meshXRootElement>());
 
    return *this;
}

commit()

meshXCompositionBuilder & meshXCompositionBuilder::commit

(

)

Commit the composition (Triggers Baking).

Returns

Reference to the builder

                                                         {
    /* Currently just a marker, bake() happens during meshx_init */
    return *this;
}

---

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

• meshx_composition_builder.hpp
• meshx_composition_builder.cpp