ocpp 0.24.1
A C++ implementation of the Open Charge Point Protocol
Public Member Functions | List of all members
ocpp::v2::Provisioning Class Reference
Inheritance diagram for ocpp::v2::Provisioning:
ocpp::v2::ProvisioningInterface ocpp::v2::MessageHandlerInterface

Public Member Functions

 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, std::optional< BootNotificationCallback > boot_notification_callback, std::optional< ValidateNetworkProfileCallback > validate_network_profile_callback, IsResetAllowedCallback is_reset_allowed_callback, ResetCallback reset_callback, StopTransactionCallback stop_transaction_callback, std::optional< VariableChangedCallback > variable_changed_callback, std::atomic< RegistrationStatusEnum > &registration_status)
 
void handle_message (const ocpp::EnhancedMessage< MessageType > &message) override
 Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message . More...
 
void boot_notification_req (const BootReasonEnum &reason, const bool initiated_by_trigger_message=false) override
 
void stop_bootnotification_timer () override
 
void on_variable_changed (const SetVariableData &set_variable_data) override
 Event handler that will update the variable internally when it has been changed on the fly. More...
 
std::vector< GetVariableResultget_variables (const std::vector< GetVariableData > &get_variable_data_vector) override
 Gets variables specified within get_variable_data_vector from the device model and returns the result. This function is used internally in order to handle GetVariables.req messages and it can be used to get variables externally. More...
 
std::map< SetVariableData, SetVariableResultset_variables (const std::vector< SetVariableData > &set_variable_data_vector, const std::string &source) override
 Sets variables specified within set_variable_data_vector in the device model and returns the result. More...
 
virtual void boot_notification_req (const BootReasonEnum &reason, const bool initiated_by_trigger_message=false)=0
 
virtual void stop_bootnotification_timer ()=0
 
virtual void on_variable_changed (const SetVariableData &set_variable_data)=0
 Event handler that will update the variable internally when it has been changed on the fly. More...
 
virtual std::vector< GetVariableResultget_variables (const std::vector< GetVariableData > &get_variable_data_vector)=0
 Gets variables specified within get_variable_data_vector from the device model and returns the result. This function is used internally in order to handle GetVariables.req messages and it can be used to get variables externally. More...
 
virtual std::map< SetVariableData, SetVariableResultset_variables (const std::vector< SetVariableData > &set_variable_data_vector, const std::string &source)=0
 Sets variables specified within set_variable_data_vector in the device model and returns the result. More...
 
virtual void handle_message (const EnhancedMessage< MessageType > &message)=0
 Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message . More...
 

Member Function Documentation

◆ boot_notification_req()

void ocpp::v2::Provisioning::boot_notification_req ( const BootReasonEnum &  reason,
const bool  initiated_by_trigger_message = false 
)
overridevirtual

◆ get_variables()

std::vector< GetVariableResult > ocpp::v2::Provisioning::get_variables ( const std::vector< GetVariableData > &  get_variable_data_vector)
overridevirtual

Gets variables specified within get_variable_data_vector from the device model and returns the result. This function is used internally in order to handle GetVariables.req messages and it can be used to get variables externally.

Parameters
get_variable_data_vectorcontains data of the variables to get
Returns
Vector containing a result for each requested variable

Implements ocpp::v2::ProvisioningInterface.

◆ handle_message()

void ocpp::v2::Provisioning::handle_message ( const ocpp::EnhancedMessage< MessageType > &  message)
overridevirtual

Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message .

Parameters
message

Implements ocpp::v2::MessageHandlerInterface.

◆ on_variable_changed()

void ocpp::v2::Provisioning::on_variable_changed ( const SetVariableData set_variable_data)
overridevirtual

Event handler that will update the variable internally when it has been changed on the fly.

Parameters
set_variable_datacontains data of the variable to set

Implements ocpp::v2::ProvisioningInterface.

◆ set_variables()

std::map< SetVariableData, SetVariableResult > ocpp::v2::Provisioning::set_variables ( const std::vector< SetVariableData > &  set_variable_data_vector,
const std::string &  source 
)
overridevirtual

Sets variables specified within set_variable_data_vector in the device model and returns the result.

Parameters
set_variable_data_vectorcontains data of the variables to set
Returns
Map containing the SetVariableData as a key and the SetVariableResult as a value for each requested change

Implements ocpp::v2::ProvisioningInterface.

◆ stop_bootnotification_timer()

void ocpp::v2::Provisioning::stop_bootnotification_timer ( )
overridevirtual

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