SYChargingWaypoint Class Reference

SYChargingWaypoint represents a charging station added to EV route by computeEVRoute method. More...

#import <SYRoutingWaypoint.h>

Inheritance diagram for SYChargingWaypoint:
Collaboration diagram for SYChargingWaypoint:

Public Types

typedef void(^ SYChargingWaypointCompatibilityCompletionBlock) (BOOL isCompatible)
 

Instance Methods

(nonnull instancetype) - initWithPlaceLink:type:name:
 Initializes SYChargingWaypoint connected to a SYPlaceLink. More...
 
(nonnull instancetype) - initWithPower:position:type:name:
 Initializes SYChargingWaypoint with specific charging power in kW and location. More...
 
(nonnull instancetype) - initWithChargingTime:position:type:name:
 Initializes SYChargingWaypoint with charging duration and location. More...
 
((unavailable("Use initializer with parameters instead.") - __attribute__
 
(nonnull instancetype) - initWithPosition:type:name:
 
(BOOL) - isCompatibleWithEVProfile:
 Checks if the charging waypoint can be used with the specified EV profile. More...
 
(void) - checkCompatibilityWithEVProfile:completion:
 Checks if the charging waypoint can be used with the specified EV profile. More...
 
- Instance Methods inherited from SYWaypoint
(nonnull instancetype) - initWithPosition:type:name:
 Initializes a SYWaypoint instance with specified geocoordinates and type. More...
 

Class Methods

((unavailable("Use initializer with parameters instead.") + __attribute__
 

Properties

SYPlaceLinklink
 Link to place which represents the best charging station accessible from specific point on route. More...
 
NSArray< SYChargingWaypoint * > * alternatives
 Alternative charging stations accessible from specific charging point on route. More...
 
float chargingPower
 Charging power in kW which is used to deduce charging time at waypoint. Can be used as alternative to link if link is unavailable. Default value is -1, which means "unspecified". More...
 
NSInteger chargingTime
 Duration in seconds which should be spent on the charging station. Can be used as alternative to link if link is unavailable. Default value is -1, which means "unspecified". More...
 
SYChargingWaypointType chargingWaypointType
 Indicates if the waypoint is suggested automatically by routing algorithm or requested directly by a user. More...
 
- Properties inherited from SYWaypoint
SYGeoCoordinateoriginalPosition
 Position for flag/pin. The original position is required for a route calculation. By default, this is set to be the same as the geocoordinates provided during construction of this SYWaypoint. More...
 
SYGeoCoordinatenavigablePosition
 Represents the suggested navigable position of the SYWaypoint - typically the coordinates on the road closest to the original position - to be used in a route calculation. Working together with the navigable position, the original position is used by the Sygic SDK for determining the side of street during arrival, and to let the calculated route approach the correct side of street, especially when there there is a physical or logical lane divider on the road. More...
 
SYGeoCoordinateselectedPosition
 Represents the selected accessible position of the SYWaypoint. This is nil before route calculation. This is only available after route calculation. More...
 
NSArray< SYGeoCoordinate * > * mappedPositions
 Represents list of accessible positions of the SYWaypoint. This is nil before route calculation. This is only available after route calculation. More...
 
SYWaypointType type
 Determines the waypoint type. More...
 
SYWaypointStatus status
 Determines if waypoint is reached or not. More...
 
NSString * name
 Waypoint's name. More...
 
SYDistance distanceFromStart
 Distance from route start in meters. More...
 
NSUInteger delay
 Delay in seconds. More...
 

Detailed Description

SYChargingWaypoint represents a charging station added to EV route by computeEVRoute method.

Member Typedef Documentation

◆ SYChargingWaypointCompatibilityCompletionBlock

- (typedef void(^ SYChargingWaypointCompatibilityCompletionBlock) (BOOL isCompatible))

Method Documentation

◆ initWithPlaceLink:type:name:

- (nonnull instancetype) initWithPlaceLink: (nonnull SYPlaceLink *)  placeLink
type: (SYWaypointType)  type
name: (nullable NSString *)  name 

Initializes SYChargingWaypoint connected to a SYPlaceLink.

◆ initWithPower:position:type:name:

- (nonnull instancetype) initWithPower: (float)  power
position: (nonnull SYGeoCoordinate *)  position
type: (SYWaypointType)  type
name: (nullable NSString *)  name 

Initializes SYChargingWaypoint with specific charging power in kW and location.

◆ initWithChargingTime:position:type:name:

- (nonnull instancetype) initWithChargingTime: (NSInteger)  chargingTime
position: (nonnull SYGeoCoordinate *)  position
type: (SYWaypointType)  type
name: (nullable NSString *)  name 

Initializes SYChargingWaypoint with charging duration and location.

◆ __attribute__ [1/2]

- ((unavailable("Use initializer with parameters instead.") __attribute__

◆ __attribute__ [2/2]

+ ((unavailable("Use initializer with parameters instead.") __attribute__

◆ initWithPosition:type:name:

- (nonnull instancetype) initWithPosition: (nonnull SYGeoCoordinate *)  position
type: (SYWaypointType)  type
name: ((unavailable("This initializer of parent class is unavailable from child class.")))  __attribute__ 

◆ isCompatibleWithEVProfile:

- (BOOL) isCompatibleWithEVProfile: (isCompatible(with:))  NS_SWIFT_NAME

Checks if the charging waypoint can be used with the specified EV profile.

Deprecated:
Please use asynchronous version of this function named checkCompatibilityWithEVProfile(completion:) instead

◆ checkCompatibilityWithEVProfile:completion:

- (void) checkCompatibilityWithEVProfile: (nonnull SYEVProfile *)  evProfile
completion: (checkCompatibility(with:completion:))  NS_SWIFT_NAME 

Checks if the charging waypoint can be used with the specified EV profile.

Property Documentation

◆ link

- (SYPlaceLink*) link
readnonatomicassign

Link to place which represents the best charging station accessible from specific point on route.

◆ alternatives

- (NSArray<SYChargingWaypoint*>*) alternatives
readnonatomicassign

Alternative charging stations accessible from specific charging point on route.

◆ chargingPower

- (float) chargingPower
readnonatomicassign

Charging power in kW which is used to deduce charging time at waypoint. Can be used as alternative to link if link is unavailable. Default value is -1, which means "unspecified".

◆ chargingTime

- (NSInteger) chargingTime
readnonatomicassign

Duration in seconds which should be spent on the charging station. Can be used as alternative to link if link is unavailable. Default value is -1, which means "unspecified".

◆ chargingWaypointType

- (SYChargingWaypointType) chargingWaypointType
readnonatomicassign

Indicates if the waypoint is suggested automatically by routing algorithm or requested directly by a user.


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