ocpp 0.24.1
A C++ implementation of the Open Charge Point Protocol
Public Member Functions | List of all members
ocpp::v2::Connector Class Reference

Represents a Connector, thus electrical outlet on a Charging Station. Single physical Connector. More...

#include <connector.hpp>

Public Member Functions

 Connector (const int32_t evse_id, const int32_t connector_id, std::shared_ptr< ComponentStateManagerInterface > component_state_manager)
 Construct a new Connector object. More...
 
OperationalStatusEnum get_effective_operational_status ()
 Gets the effective Operative/Inoperative status of this connector.
 
ConnectorStatusEnum get_effective_connector_status ()
 Gets the effective Available/Unavailable/Faulted/Reserved/Occupied status of this connector.
 
void submit_event (ConnectorEvent event)
 Adjust the state of the connector according to the event that was submitted. More...
 
void set_connector_operative_status (OperationalStatusEnum new_status, bool persist)
 Switches the operative status of the connector and recomputes its effective status. More...
 
void restore_connector_operative_status ()
 Restores the operative status of the connector to the persisted status and recomputes its effective status.
 

Detailed Description

Represents a Connector, thus electrical outlet on a Charging Station. Single physical Connector.

Constructor & Destructor Documentation

◆ Connector()

ocpp::v2::Connector::Connector ( const int32_t  evse_id,
const int32_t  connector_id,
std::shared_ptr< ComponentStateManagerInterface component_state_manager 
)

Construct a new Connector object.

Parameters
evse_idid of the EVSE the connector is ap art of
connector_idid of the connector
component_state_managerA shared reference to the component state manager

Member Function Documentation

◆ set_connector_operative_status()

void ocpp::v2::Connector::set_connector_operative_status ( OperationalStatusEnum  new_status,
bool  persist 
)

Switches the operative status of the connector and recomputes its effective status.

Parameters
new_statusThe operative status to switch to
persistTrue if the updated operative status setting should be persisted

◆ submit_event()

void ocpp::v2::Connector::submit_event ( ConnectorEvent  event)

Adjust the state of the connector according to the event that was submitted.

Parameters
event

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