Skip to content

Commit

Permalink
Add function description to newly added functions
Browse files Browse the repository at this point in the history
Signed-off-by: Wilco den Besten <[email protected]>
  • Loading branch information
WilcodenBesten committed Oct 10, 2024
1 parent 14284ba commit 093cb14
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
13 changes: 13 additions & 0 deletions include/ocpp/v201/charge_point.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,24 @@ class ChargePointInterface {
virtual std::vector<CompositeSchedule> get_all_composite_schedules(const int32_t duration,
const ChargingRateUnitEnum& unit) = 0;

/// \brief Gets the configured NetworkConnectionProfile based on the given \p configuration_slot . The
/// central system uri of the connection options will not contain ws:// or wss:// because this method removes it if
/// present. This returns the value from the cached network connection profiles. \param
/// network_configuration_priority \return
virtual std::optional<NetworkConnectionProfile>
get_network_connection_profile(const int32_t configuration_slot) = 0;

/// \brief Get the priority of the given configuration slot.
/// \param configuration_slot The configuration slot to get the priority from.
/// \return The priority if the configuration slot exists.
///
virtual std::optional<int> get_configuration_slot_priority(const int configuration_slot) = 0;

/// @brief Get the network connection priorities.
/// Each item in the vector contains the configured configuration slots, where the slot with index 0 has the highest
/// priority.
/// @return The network connection priorities
///
virtual const std::vector<std::string>& get_network_connection_priorities() const = 0;
};

Expand Down
7 changes: 6 additions & 1 deletion include/ocpp/v201/connectivity_manager.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ class ConnectivityManager {
void set_configure_network_connection_profile_callback(ConfigureNetworkConnectionProfileCallback callback);

/// \brief Gets the configured NetworkConnectionProfile based on the given \p configuration_slot . The
/// central system uri ofthe connection options will not contain ws:// or wss:// because this method removes it if
/// central system uri of the connection options will not contain ws:// or wss:// because this method removes it if
/// present. This returns the value from the cached network connection profiles. \param
/// network_configuration_priority \return
std::optional<NetworkConnectionProfile> get_network_connection_profile(const int32_t configuration_slot);
Expand All @@ -96,6 +96,11 @@ class ConnectivityManager {
///
std::optional<int> get_configuration_slot_priority(const int configuration_slot);

/// @brief Get the network connection priorities.
/// Each item in the vector contains the configured configuration slots, where the slot with index 0 has the highest
/// priority.
/// @return The network connection priorities
///
const std::vector<std::string>& get_network_connection_priorities() const;

/// \brief Check if the websocket is connected
Expand Down

0 comments on commit 093cb14

Please sign in to comment.