Change 'BlockContext' to 'FunctionalBlockContext'. Add documentation.

Signed-off-by: Maaike Zijderveld, iolar <git.mail@iolar.nl>

Author: maaikez

include/ocpp/v2/charge_point.hpp

@@ -49,7 +49,7 @@ class DeviceModel;
 class DeviceModelStorageInterface;
 class EvseManager;
 
-struct BlockContext;
+struct FunctionalBlockContext;
 
 class UnexpectedMessageTypeFromCSMS : public std::runtime_error {
     using std::runtime_error::runtime_error;
@@ -341,7 +341,7 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
     std::unique_ptr<MessageDispatcherInterface<MessageType>> message_dispatcher;
 
     // Functional blocks
-    std::unique_ptr<BlockContext> block_context;
+    std::unique_ptr<FunctionalBlockContext> functional_block_context;
     std::unique_ptr<DataTransferInterface> data_transfer;
     std::unique_ptr<ReservationInterface> reservation;
     std::unique_ptr<AvailabilityInterface> availability;

include/ocpp/v2/functional_blocks/authorization.hpp

@@ -6,7 +6,7 @@
 #include <ocpp/v2/message_handler.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 struct AuthorizationCacheEntry;
 struct AuthorizeResponse;
 struct ClearCacheRequest;
@@ -44,7 +44,7 @@ class AuthorizationInterface : public MessageHandlerInterface {
 
 class Authorization : public AuthorizationInterface {
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
 
     // threads and synchronization
     bool auth_cache_cleanup_required;
@@ -54,7 +54,7 @@ class Authorization : public AuthorizationInterface {
     std::atomic_bool auth_cache_cleanup_handler_running;
 
 public:
-    explicit Authorization(const BlockContext& context);
+    explicit Authorization(const FunctionalBlockContext& context);
     ~Authorization();
     void start_auth_cache_cleanup_thread() override;
     void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;

include/ocpp/v2/functional_blocks/availability.hpp

@@ -8,7 +8,7 @@
 #include <ocpp/v2/messages/ChangeAvailability.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 
 struct HeartbeatResponse;
 
@@ -75,7 +75,7 @@ typedef std::function<void()> AllConnectorsUnavailableCallback;
 
 class Availability : public AvailabilityInterface {
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
 
     std::optional<TimeSyncCallback> time_sync_callback;
     std::optional<AllConnectorsUnavailableCallback> all_connectors_unavailable_callback;
@@ -86,7 +86,8 @@ class Availability : public AvailabilityInterface {
     Everest::SteadyTimer heartbeat_timer;
 
 public:
-    Availability(const BlockContext& block_context, std::optional<TimeSyncCallback> time_sync_callback,
+    Availability(const FunctionalBlockContext& functional_block_context,
+                 std::optional<TimeSyncCallback> time_sync_callback,
                  std::optional<AllConnectorsUnavailableCallback> all_connectors_unavailable_callback);
     ~Availability();
     void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;

include/ocpp/v2/functional_blocks/data_transfer.hpp

@@ -7,7 +7,7 @@
 
 namespace ocpp {
 namespace v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 struct DataTransferRequest;
 struct DataTransferResponse;
 
@@ -35,16 +35,16 @@ class DataTransferInterface : public MessageHandlerInterface {
 class DataTransfer : public DataTransferInterface {
 
 private:
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     std::optional<std::function<DataTransferResponse(const DataTransferRequest& request)>> data_transfer_callback;
     std::chrono::seconds response_timeout;
 
 public:
-    DataTransfer(const BlockContext& block_context,
+    DataTransfer(const FunctionalBlockContext& functional_block_context,
                  const std::optional<std::function<DataTransferResponse(const DataTransferRequest& request)>>&
                      data_transfer_callback,
                  const std::chrono::seconds response_timeout) :
-        context(block_context), data_transfer_callback(data_transfer_callback), response_timeout(response_timeout){};
+        context(functional_block_context), data_transfer_callback(data_transfer_callback), response_timeout(response_timeout){};
 
     void handle_message(const EnhancedMessage<MessageType>& message) override;
 

include/ocpp/v2/functional_blocks/diagnostics.hpp

@@ -9,7 +9,7 @@
 
 namespace ocpp::v2 {
 class AuthorizationInterface;
-struct BlockContext;
+struct FunctionalBlockContext;
 
 struct GetLogRequest;
 struct GetLogResponse;
@@ -44,7 +44,7 @@ class DiagnosticsInterface : public MessageHandlerInterface {
 
 class Diagnostics : public DiagnosticsInterface {
 public:
-    Diagnostics(const BlockContext& context, AuthorizationInterface& authorization,
+    Diagnostics(const FunctionalBlockContext& context, AuthorizationInterface& authorization,
                 GetLogRequestCallback get_log_request_callback,
                 std::optional<GetCustomerInformationCallback> get_customer_information_callback,
                 std::optional<ClearCustomerInformationCallback> clear_customer_information_callback);
@@ -55,7 +55,7 @@ class Diagnostics : public DiagnosticsInterface {
     void process_triggered_monitors() override;
 
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     AuthorizationInterface& authorization;
     /// \brief Updater for triggered monitors
     MonitoringUpdater monitoring_updater;

include/ocpp/v2/functional_blocks/display_message.hpp

@@ -8,7 +8,7 @@
 #include <ocpp/v2/messages/SetDisplayMessage.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 struct GetDisplayMessagesRequest;
 struct ClearDisplayMessageResponse;
 struct ClearDisplayMessageRequest;
@@ -47,13 +47,13 @@ class DisplayMessageInterface : public MessageHandlerInterface {
 class DisplayMessageBlock : public DisplayMessageInterface {
 
 public:
-    DisplayMessageBlock(const BlockContext& block_context, GetDisplayMessageCallback get_display_message_callback,
+    DisplayMessageBlock(const FunctionalBlockContext& functional_block_context, GetDisplayMessageCallback get_display_message_callback,
                         SetDisplayMessageCallback set_display_message_callback,
                         ClearDisplayMessageCallback clear_display_message_callback);
     virtual void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;
 
 private:
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
 
     GetDisplayMessageCallback get_display_message_callback;
     SetDisplayMessageCallback set_display_message_callback;

include/ocpp/v2/functional_blocks/firmware_update.hpp

@@ -7,7 +7,7 @@
 
 namespace ocpp::v2 {
 // Formward declarations.
-struct BlockContext;
+struct FunctionalBlockContext;
 class AvailabilityInterface;
 class SecurityInterface;
 
@@ -29,7 +29,7 @@ class FirmwareUpdateInterface : public MessageHandlerInterface {
 
 class FirmwareUpdate : public FirmwareUpdateInterface {
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     AvailabilityInterface& availability;
     SecurityInterface& security;
 
@@ -43,7 +43,7 @@ class FirmwareUpdate : public FirmwareUpdateInterface {
     FirmwareStatusEnum firmware_status_before_installing = FirmwareStatusEnum::SignatureVerified;
 
 public:
-    FirmwareUpdate(const BlockContext& block_context, AvailabilityInterface& availability, SecurityInterface& security,
+    FirmwareUpdate(const FunctionalBlockContext& functional_block_context, AvailabilityInterface& availability, SecurityInterface& security,
                    UpdateFirmwareRequestCallback update_firmware_request_callback,
                    std::optional<AllConnectorsUnavailableCallback> all_connectors_unavailable_callback);
     void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;

include/ocpp/v2/functional_blocks/block_context.hpp include/ocpp/v2/functional_blocks/functional_block_context.hpp

@@ -16,7 +16,11 @@ class EvseManagerInterface;
 class DatabaseHandlerInterface;
 class ComponentStateManagerInterface;
 
-struct BlockContext {
+/// \brief Context / requirements for the functional blocks.
+///
+/// All functional blocks will get this context. The references and pointers in this struct are used by all or most
+/// functional blocks.
+struct FunctionalBlockContext {
     MessageDispatcherInterface<MessageType>& message_dispatcher;
     DeviceModel& device_model;
     ConnectivityManagerInterface& connectivity_manager;
@@ -25,10 +29,10 @@ struct BlockContext {
     EvseSecurity& evse_security;
     ComponentStateManagerInterface& component_state_manager;
 
-    BlockContext(MessageDispatcherInterface<MessageType>& message_dispatcher, DeviceModel& device_model,
-                 ConnectivityManagerInterface& connectivity_manager, EvseManagerInterface& evse_manager,
-                 DatabaseHandlerInterface& database_handler, EvseSecurity& evse_security,
-                 ComponentStateManagerInterface& component_state_manager) :
+    FunctionalBlockContext(MessageDispatcherInterface<MessageType>& message_dispatcher, DeviceModel& device_model,
+                           ConnectivityManagerInterface& connectivity_manager, EvseManagerInterface& evse_manager,
+                           DatabaseHandlerInterface& database_handler, EvseSecurity& evse_security,
+                           ComponentStateManagerInterface& component_state_manager) :
         message_dispatcher(message_dispatcher),
         device_model(device_model),
         connectivity_manager(connectivity_manager),

include/ocpp/v2/functional_blocks/meter_values.hpp

@@ -9,7 +9,7 @@
 #include <ocpp/v2/average_meter_values.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 
 class MeterValuesInterface : public MessageHandlerInterface {
 public:
@@ -29,7 +29,7 @@ class MeterValuesInterface : public MessageHandlerInterface {
 class MeterValues : public MeterValuesInterface {
 public:
     virtual ~MeterValues() override = default;
-    explicit MeterValues(const BlockContext& block_context);
+    explicit MeterValues(const FunctionalBlockContext& functional_block_context);
     void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;
     void update_aligned_data_interval() override;
     void on_meter_value(const int32_t evse_id, const MeterValue& meter_value) override;
@@ -40,7 +40,7 @@ class MeterValues : public MeterValuesInterface {
                           const bool initiated_by_trigger_message = false) override;
 
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
 
     ClockAlignedTimer aligned_meter_values_timer;
     AverageMeterValues aligned_data_evse0; // represents evseId = 0 meter value

include/ocpp/v2/functional_blocks/provisioning.hpp

@@ -6,7 +6,7 @@
 #include <ocpp/v2/message_handler.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 class OcspUpdaterInterface;
 
 class AvailabilityInterface;
@@ -64,7 +64,7 @@ class ProvisioningInterface : public MessageHandlerInterface {
 
 class Provisioning : public ProvisioningInterface {
 public:
-    Provisioning(const BlockContext& block_context, MessageQueue<v2::MessageType>& message_queue,
+    Provisioning(const FunctionalBlockContext& functional_block_context, MessageQueue<v2::MessageType>& message_queue,
                  OcspUpdaterInterface& ocsp_updater, AvailabilityInterface& availability,
                  MeterValuesInterface& meter_values, SecurityInterface& security, DiagnosticsInterface& diagnostics,
                  TransactionInterface& transaction, std::optional<TimeSyncCallback> time_sync_callback,
@@ -84,7 +84,7 @@ class Provisioning : public ProvisioningInterface {
     set_variables(const std::vector<SetVariableData>& set_variable_data_vector, const std::string& source) override;
 
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     MessageQueue<v2::MessageType>& message_queue;
     OcspUpdaterInterface& ocsp_updater;
 

include/ocpp/v2/functional_blocks/remote_transaction_control.hpp

@@ -6,7 +6,7 @@
 #include <ocpp/v2/message_handler.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 class EvseInterface;
 
 class TransactionInterface;
@@ -39,7 +39,7 @@ class RemoteTransactionControlInterface : public MessageHandlerInterface {
 
 class RemoteTransactionControl : public RemoteTransactionControlInterface {
 public:
-    RemoteTransactionControl(const BlockContext& block_context, TransactionInterface& transaction,
+    RemoteTransactionControl(const FunctionalBlockContext& functional_block_context, TransactionInterface& transaction,
                              SmartChargingInterface& smart_charging, MeterValuesInterface& meter_values,
                              AvailabilityInterface& availability, FirmwareUpdateInterface& firmware_update,
                              SecurityInterface& security, ReservationInterface* reservation,
@@ -52,7 +52,7 @@ class RemoteTransactionControl : public RemoteTransactionControlInterface {
     void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;
 
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
 
     TransactionInterface& transaction;
     SmartChargingInterface& smart_charging;

include/ocpp/v2/functional_blocks/reservation.hpp

@@ -6,7 +6,7 @@
 #pragma once
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 class EvseInterface;
 
 struct ReserveNowRequest;
@@ -31,7 +31,7 @@ class ReservationInterface : public MessageHandlerInterface {
 
 class Reservation : public ReservationInterface {
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
 
     /// \brief Callback function is called when a reservation request is received from the CSMS
     ReserveNowCallback reserve_now_callback;
@@ -44,7 +44,7 @@ class Reservation : public ReservationInterface {
     IsReservationForTokenCallback is_reservation_for_token_callback;
 
 public:
-    Reservation(const BlockContext& block_context, ReserveNowCallback reserve_now_callback,
+    Reservation(const FunctionalBlockContext& functional_block_context, ReserveNowCallback reserve_now_callback,
                 CancelReservationCallback cancel_reservation_callback,
                 const IsReservationForTokenCallback is_reservation_for_token_callback);
     virtual void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;

include/ocpp/v2/functional_blocks/security.hpp

@@ -12,7 +12,7 @@ namespace ocpp {
 class MessageLogging;
 
 namespace v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 
 struct CertificateSignedRequest;
 struct CertificateSignedResponse;
@@ -47,7 +47,7 @@ class SecurityInterface : public MessageHandlerInterface {
 
 class Security : public SecurityInterface {
 public:
-    Security(const BlockContext& block_context, MessageLogging& logging, OcspUpdaterInterface& ocsp_updater,
+    Security(const FunctionalBlockContext& functional_block_context, MessageLogging& logging, OcspUpdaterInterface& ocsp_updater,
              SecurityEventCallback security_event_callback);
     virtual ~Security();
     void handle_message(const EnhancedMessage<MessageType>& message) override;
@@ -66,7 +66,7 @@ class Security : public SecurityInterface {
                                       const bool initiated_by_trigger_message = false) override;
 
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     MessageLogging& logging;
     OcspUpdaterInterface& ocsp_updater;
 

include/ocpp/v2/functional_blocks/smart_charging.hpp

@@ -8,7 +8,7 @@
 #include <ocpp/v2/evse.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 class SmartChargingHandlerInterface;
 
 struct GetChargingProfilesRequest;
@@ -121,11 +121,11 @@ class SmartChargingInterface : public MessageHandlerInterface {
 
 class SmartCharging : public SmartChargingInterface {
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     std::function<void()> set_charging_profiles_callback;
 
 public:
-    SmartCharging(const BlockContext& block_context, std::function<void()> set_charging_profiles_callback);
+    SmartCharging(const FunctionalBlockContext& functional_block_context, std::function<void()> set_charging_profiles_callback);
     void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;
     GetCompositeScheduleResponse get_composite_schedule(const GetCompositeScheduleRequest& request) override;
     std::optional<CompositeSchedule> get_composite_schedule(int32_t evse_id, std::chrono::seconds duration,

include/ocpp/v2/functional_blocks/tariff_and_cost.hpp

@@ -8,7 +8,7 @@
 #include <ocpp/v2/functional_blocks/display_message.hpp>
 
 namespace ocpp::v2 {
-struct BlockContext;
+struct FunctionalBlockContext;
 class MeterValuesInterface;
 
 struct CostUpdatedRequest;
@@ -34,7 +34,7 @@ class TariffAndCostInterface : public MessageHandlerInterface {
 
 class TariffAndCost : public TariffAndCostInterface {
 public:
-    TariffAndCost(const BlockContext& block_context, MeterValuesInterface& meter_values,
+    TariffAndCost(const FunctionalBlockContext& functional_block_context, MeterValuesInterface& meter_values,
                   std::optional<SetDisplayMessageCallback>& set_display_message_callback,
                   std::optional<SetRunningCostCallback>& set_running_cost_callback,
                   boost::asio::io_service& io_service);
@@ -45,7 +45,7 @@ class TariffAndCost : public TariffAndCostInterface {
                                 const json& original_transaction_event_response) override;
 
 private: // Members
-    const BlockContext& context;
+    const FunctionalBlockContext& context;
     MeterValuesInterface& meter_values;
     std::optional<SetDisplayMessageCallback> set_display_message_callback;
     std::optional<SetRunningCostCallback> set_running_cost_callback;