SYRoadDetail Class Reference

Represents a road on the route. More...

#import <SYRoutingRoadDetail.h>

Inheritance diagram for SYRoadDetail:

Collaboration diagram for SYRoadDetail:

Instance Methods
(void)	- getDirectionAtTime:completion:
	Get direction of road in defined time. More...
(void)	- getSpeedLimitAtTime:orientation:profile:completion:
	Get direction of road in defined time. More...
(void)	- getIsOpenAtTime:orientation:profile:restrictions:completion:
	Get direction of road in defined time. More...

Protected Types
typedef void(^	GetDirectionAtTimeBlock) (SYRoadDirection direction)
typedef void(^	GetSpeedLimitAtTimeBlock) (SYSpeed speedLimit)
typedef void(^	GetIsOpenAtTimeBlock) (BOOL isOpen)

Properties
SYRoadId *	roadId
	The unique identifier of SYRoadDetail. More...
SYCountryIso *	country
	Represents country iso code. More...
SYLength	length
	The lenght of the road on route. More...
SYRoadType	type
	Represents a type of the road on route. More...
NSSet< NSNumber * > *	attributes
	The collection of SYRoadAttribute. More...
NSArray< SYGeoCoordinate * > *	geometry
	Represents a collection of coordinates on the road. More...
SYSpeed	speedLimit
	The speed limit in kmh, or 0 if the information is not available. More...
NSString *	roadName
	The name of the road, or an empty string if the data is not available. More...
NSString *	cityName
	The name of the city, or an empty string if the data is not available. More...
NSString *	areaName
	The name of the area, or an empty string if the data is not available. More...

Detailed Description

Represents a road on the route.

Member Typedef Documentation

GetDirectionAtTimeBlock

- (typedef void(^ GetDirectionAtTimeBlock) (SYRoadDirection direction))

protected

GetSpeedLimitAtTimeBlock

- (typedef void(^ GetSpeedLimitAtTimeBlock) (SYSpeed speedLimit))

protected

GetIsOpenAtTimeBlock

- (typedef void(^ GetIsOpenAtTimeBlock) (BOOL isOpen))

protected

Method Documentation

getDirectionAtTime:completion:

- (void) getDirectionAtTime:		(nonnull NSDate *)	time
completion:		(nonnull GetDirectionAtTimeBlock)	completion

Get direction of road in defined time.

Parameters

time	Time at which the requested road restriction should be retrieved
completion	final call with retrieved direction

getSpeedLimitAtTime:orientation:profile:completion:

- (void) getSpeedLimitAtTime:		(nonnull NSDate *)	time
orientation:		(SYRoadOrientation)	orientation
profile:		(nonnull SYVehicleProfile *)	profile
completion:		(nonnull GetSpeedLimitAtTimeBlock)	completion

Get direction of road in defined time.

Parameters

time	Time at which the requested road restriction should be retrieved
orientation	orientation of road in map, could be retrieved from route element
profile	logistic vehicle profile
completion	final call with retrieved speed limit

getIsOpenAtTime:orientation:profile:restrictions:completion:

- (void) getIsOpenAtTime:		(nonnull NSDate *)	time
orientation:		(SYRoadOrientation)	orientation
profile:		(nonnull SYVehicleProfile *)	profile
restrictions:		(nonnull NSArray< SYVehicleRestriction * > *)	restrictions
completion:		(nonnull GetIsOpenAtTimeBlock)	completion

Get direction of road in defined time.

Parameters

time	Time at which the requested road restriction should be retrieved
orientation	orientation of road in map, could be retrieved from route element
profile	logistic vehicle profile
restrictions	dimensional vehicle restrictions, we allow only one restriction per type, otherwise behaviour is undefined
completion	final call with retrieved value, if road is open

Property Documentation

roadId

- (SYRoadId*) roadId

readnonatomicassign

The unique identifier of SYRoadDetail.

country

- (SYCountryIso*) country

readnonatomicassign

Represents country iso code.

length

- (SYLength) length

readnonatomicassign

The lenght of the road on route.

type

- (SYRoadType) type

readnonatomicassign

Represents a type of the road on route.

attributes

- (NSSet<NSNumber*>*) attributes

readnonatomicassign

The collection of SYRoadAttribute.

geometry

- (NSArray<SYGeoCoordinate*>*) geometry

readnonatomicassign

Represents a collection of coordinates on the road.

speedLimit

- (SYSpeed) speedLimit

readnonatomicassign

The speed limit in kmh, or 0 if the information is not available.

roadName

- (NSString*) roadName

readnonatomicassign

The name of the road, or an empty string if the data is not available.

cityName

- (NSString*) cityName

readnonatomicassign

The name of the city, or an empty string if the data is not available.

areaName

- (NSString*) areaName

readnonatomicassign

The name of the area, or an empty string if the data is not available.

---

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

• SYRoutingRoadDetail.h