SDK (Java): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
The {{software}} offers an [[API]], which allows external application to interact with it. However, the specific options available via the API are not always intuitively relatable to specific operations when using the client application. To compensate for this, the SDK wraps a number of these operations into more human-understandable functions. In addition, it provides functionality to handle some of the complexity related to obtaining, storing, updating and using data present in the {{software}}.
Te Java SDK is a [[Software Development Kit]] written in and for Java, developed in lockstep with the {{software}} itself. It is used internally for the development of the client application, by communicating via the [[API]].


==Getting started with the SDK==
===Obtain and use===
At this time, the SDK is only available for Java, and is still in development. The recommended IDE is [https://eclipse.org/ Eclipse], although other developments environments can be used as well.
The SDK is freely available via the API of the {{software}}. For the LTS-compatible version, it can be found in the following location:


===Obtaining the SDK===
https://engine.tygron.com/api/developer/.  
The SDK is freely available from https://engine.tygron.com/api/developer/.  


The contents are an Eclipse Java Project which can be imported as a dependency for other Projects.
The contents are an Eclipse Java Project which can be imported as a dependency for other Projects. Instructions for its installation and use are included in a README file.


===Components===
===Components===
Line 36: Line 35:


{{article end
{{article end
|seealso=
* [[API]]
* [[SDK (Python)]]
|references=
|references=
   <references>
   <references>

Latest revision as of 07:49, 9 July 2024

Te Java SDK is a Software Development Kit written in and for Java, developed in lockstep with the Tygron Platform itself. It is used internally for the development of the client application, by communicating via the API.

Obtain and use

The SDK is freely available via the API of the Tygron Platform. For the LTS-compatible version, it can be found in the following location:

https://engine.tygron.com/api/developer/.

The contents are an Eclipse Java Project which can be imported as a dependency for other Projects. Instructions for its installation and use are included in a README file.

Components

The following components are available in the Java SDK:

Component Description
SettingsManager Stores most recently used settings. Required by other components of the SDK.
ServicesManager Facilitates authentication and communication to the Tygron Platform.
Projects and Sessions The data contained in a Project (such as Buildings and Overlays), and the live in-memory state of that Project data respectively.
SlotConnection The connector to one specific session, facilitating interactions and a continuously updating representation of data.
EventManager Allows for the listening of specific occurrences or events from the Session.
MapLinks and Items The enumerating types of all the available data, as well as the actual data from a Project respectively.
JTS Topology Suite[1] An included library for the definition of geo data, as well as the translations of geo data.

Examples

The SDK contains example code which can be run both to test the functionality and successful installation of the SDK, but also to provide a first script which can be copied, changed, and expanded upon to create further tools.

Run "ExampleTest" via JUnit to get started.

See also

References

  1. JTS Topology Suite ∙ Found at: https://www.tsusiatsoftware.net/jts/main.html ∙ (last visited: 09-07-2024)