Telematics SDK - Interface Specification  v1.38.19
telux::tel::Geometry Class Reference

Public Member Functions

 Geometry (std::shared_ptr< Polygon > polygon)
 
 Geometry (std::shared_ptr< Circle > circle)
 
GeometryType getType () const
 
std::shared_ptr< PolygongetPolygon () const
 
std::shared_ptr< CirclegetCircle () const
 

Detailed Description

This class represents warning area geometry to perform geofencing on alert.

Constructor & Destructor Documentation

telux::tel::Geometry::Geometry ( std::shared_ptr< Polygon polygon)

Geometry constructor.

Parameters
[in]polygonPolygon
telux::tel::Geometry::Geometry ( std::shared_ptr< Circle circle)

Geometry constructor.

Parameters
[in]circleCircle

Member Function Documentation

GeometryType telux::tel::Geometry::getType ( ) const

Get the geometry type.

Returns
GeometryType.
Note
Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.
std::shared_ptr<Polygon> telux::tel::Geometry::getPolygon ( ) const

Get polygon goemetry as warning area to perform geofencing. This method should be called only if geometry type returned by getType() API is GeometryType::POLYGON

Returns
Polygon geometry object.
Note
Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.
std::shared_ptr<Circle> telux::tel::Geometry::getCircle ( ) const

Get circle goemetry as warning area to perform geofencing. This method should be called only if geometry type returned by getType() API is GeometryType::CIRCLE

Returns
Circle geometry object.
Note
Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.