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

Public Member Functions

 TransactionBlock (const FunctionalBlockContext &functional_block_context, MessageQueue< v2::MessageType > &message_queue, AuthorizationInterface &authorization, AvailabilityInterface &availability, SmartChargingInterface &smart_charging, TariffAndCostInterface &tariff_and_cost, StopTransactionCallback stop_transaction_callback, PauseChargingCallback pause_charging_callback, std::optional< TransactionEventCallback > transaction_event_callback, std::optional< TransactionEventResponseCallback > transaction_event_response_callback, ResetCallback reset_callback)
 
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 on_transaction_started (const int32_t evse_id, const int32_t connector_id, const std::string &session_id, const DateTime &timestamp, const TriggerReasonEnum trigger_reason, const MeterValue &meter_start, const std::optional< IdToken > &id_token, const std::optional< IdToken > &group_id_token, const std::optional< int32_t > &reservation_id, const std::optional< int32_t > &remote_start_id, const ChargingStateEnum charging_state) override
 Event handler that should be called when a transaction has started. More...
 
void on_transaction_finished (const int32_t evse_id, const DateTime &timestamp, const MeterValue &meter_stop, const ReasonEnum reason, const TriggerReasonEnum trigger_reason, const std::optional< IdToken > &id_token, const std::optional< std::string > &signed_meter_value, const ChargingStateEnum charging_state) override
 Event handler that should be called when a transaction has finished. More...
 
void transaction_event_req (const TransactionEventEnum &event_type, const DateTime &timestamp, const Transaction &transaction, const TriggerReasonEnum &trigger_reason, const int32_t seq_no, const std::optional< int32_t > &cable_max_current, const std::optional< EVSE > &evse, const std::optional< IdToken > &id_token, const std::optional< std::vector< MeterValue > > &meter_value, const std::optional< int32_t > &number_of_phases_used, const bool offline, const std::optional< int32_t > &reservation_id, const bool initiated_by_trigger_message=false) override
 
void set_remote_start_id_for_evse (const int32_t evse_id, const IdToken id_token, const int32_t remote_start_id) override
 
void schedule_reset (const std::optional< int32_t > reset_scheduled_evseid) override
 
virtual void on_transaction_started (const int32_t evse_id, const int32_t connector_id, const std::string &session_id, const DateTime &timestamp, const TriggerReasonEnum trigger_reason, const MeterValue &meter_start, const std::optional< IdToken > &id_token, const std::optional< IdToken > &group_id_token, const std::optional< int32_t > &reservation_id, const std::optional< int32_t > &remote_start_id, const ChargingStateEnum charging_state)=0
 Event handler that should be called when a transaction has started. More...
 
virtual void on_transaction_finished (const int32_t evse_id, const DateTime &timestamp, const MeterValue &meter_stop, const ReasonEnum reason, const TriggerReasonEnum trigger_reason, const std::optional< IdToken > &id_token, const std::optional< std::string > &signed_meter_value, const ChargingStateEnum charging_state)=0
 Event handler that should be called when a transaction has finished. More...
 
virtual void transaction_event_req (const TransactionEventEnum &event_type, const DateTime &timestamp, const Transaction &transaction, const TriggerReasonEnum &trigger_reason, const int32_t seq_no, const std::optional< int32_t > &cable_max_current, const std::optional< EVSE > &evse, const std::optional< IdToken > &id_token, const std::optional< std::vector< MeterValue > > &meter_value, const std::optional< int32_t > &number_of_phases_used, const bool offline, const std::optional< int32_t > &reservation_id, const bool initiated_by_trigger_message=false)=0
 
virtual void set_remote_start_id_for_evse (const int32_t evse_id, const IdToken id_token, const int32_t remote_start_id)=0
 
virtual void schedule_reset (const std::optional< int32_t > reset_scheduled_evseid)=0
 
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

◆ handle_message()

void ocpp::v2::TransactionBlock::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_transaction_finished()

void ocpp::v2::TransactionBlock::on_transaction_finished ( const int32_t  evse_id,
const DateTime timestamp,
const MeterValue meter_stop,
const ReasonEnum  reason,
const TriggerReasonEnum  trigger_reason,
const std::optional< IdToken > &  id_token,
const std::optional< std::string > &  signed_meter_value,
const ChargingStateEnum  charging_state 
)
overridevirtual

Event handler that should be called when a transaction has finished.

Parameters
evse_id
timestamp
meter_stop
reason
id_token
signed_meter_value
charging_state

Implements ocpp::v2::TransactionInterface.

◆ on_transaction_started()

void ocpp::v2::TransactionBlock::on_transaction_started ( const int32_t  evse_id,
const int32_t  connector_id,
const std::string &  session_id,
const DateTime timestamp,
const TriggerReasonEnum  trigger_reason,
const MeterValue meter_start,
const std::optional< IdToken > &  id_token,
const std::optional< IdToken > &  group_id_token,
const std::optional< int32_t > &  reservation_id,
const std::optional< int32_t > &  remote_start_id,
const ChargingStateEnum  charging_state 
)
overridevirtual

Event handler that should be called when a transaction has started.

Parameters
evse_id
connector_id
session_id
timestamp
trigger_reason
meter_start
id_token
group_id_tokenOptional group id token
reservation_id
remote_start_id
charging_stateThe new charging state

Implements ocpp::v2::TransactionInterface.

◆ schedule_reset()

void ocpp::v2::TransactionBlock::schedule_reset ( const std::optional< int32_t >  reset_scheduled_evseid)
overridevirtual

◆ set_remote_start_id_for_evse()

void ocpp::v2::TransactionBlock::set_remote_start_id_for_evse ( const int32_t  evse_id,
const IdToken  id_token,
const int32_t  remote_start_id 
)
overridevirtual

◆ transaction_event_req()

void ocpp::v2::TransactionBlock::transaction_event_req ( const TransactionEventEnum &  event_type,
const DateTime timestamp,
const Transaction transaction,
const TriggerReasonEnum &  trigger_reason,
const int32_t  seq_no,
const std::optional< int32_t > &  cable_max_current,
const std::optional< EVSE > &  evse,
const std::optional< IdToken > &  id_token,
const std::optional< std::vector< MeterValue > > &  meter_value,
const std::optional< int32_t > &  number_of_phases_used,
const bool  offline,
const std::optional< int32_t > &  reservation_id,
const bool  initiated_by_trigger_message = false 
)
overridevirtual

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