camaraproject / DeviceLocation

Repository to describe, develop, document and test the DeviceLocation API family
Apache License 2.0
21 stars 32 forks source link

fix/ location-verification: remodel-Area-inheritance #77

Closed jlurien closed 1 year ago

jlurien commented 1 year ago

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #72

Special notes for reviewers:

type moved to base class

Changelog input

n/a

Additional documentation

n/a

jlurien commented 1 year ago

Did same work for the raw location and seems were aligned - good if you can take a look to make sure about this alignment.

3 minor requests for your consideration:

  • Instead of typeI renamed the attribute as areaType

OK, indeed I was already considering this name, just in case we have for example some codeType or similar in the future.

  • Instead of location(line 126) could we use centeras we describe a circle.
  • For same reason instead of accuracycould we rename the attribute radius.

Modelling areas as geometrical figures, it could make sense. Originally it was meant to represent an specific target point with some accuracy, which could be understood as the device more likely to be close to the center. If we add other type of areas, as code areas, is just another area.

I will ask internally for other opinions.

This more explicit for the API consumer.

jlurien commented 1 year ago

@bigludo7 I have renamed the Area and Circle properties with your suggestions