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

Public Member Functions

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...
 
- Public Member Functions inherited from ocpp::v2::MessageHandlerInterface
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

◆ get_variables()

virtual std::vector< GetVariableResult > ocpp::v2::ProvisioningInterface::get_variables ( const std::vector< GetVariableData > &  get_variable_data_vector)
pure virtual

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

Implemented in ocpp::v2::Provisioning.

◆ on_variable_changed()

virtual void ocpp::v2::ProvisioningInterface::on_variable_changed ( const SetVariableData set_variable_data)
pure virtual

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

Implemented in ocpp::v2::Provisioning.

◆ set_variables()

virtual std::map< SetVariableData, SetVariableResult > ocpp::v2::ProvisioningInterface::set_variables ( const std::vector< SetVariableData > &  set_variable_data_vector,
const std::string &  source 
)
pure virtual

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

Implemented in ocpp::v2::Provisioning.


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