What is TotalTide?
Admiralty TotalTide is an award winning tidal prediction program. It provides tidal height and tidal stream data prediction capability world wide. The software automates the prediction process, eliminates the possibility of user error and provides an easy means of viewing both underkeel and overhead clearances.

Why is there a TotalTide SDK and what does it consist of?
At an early stage ECS/ECDIS OEMs recognised the potential for using TotalTide within their existing ECDIS and other navigation-related applications. The ability to integrate tidal height and stream outputs of TotalTide directly within their applications to support and enhance existing and new features such as route planning in ECDIS rather than just being graphically displayed in a standalone application is an obvious benefit. UKHO also recognises the benefit of having TotalTide enabled applications on the market.

TotalTide is COM enabled. The main application supports an Automation Interface. In addition there is a low level interface to the calculation engine and a graph control. These services are designed to facilitate integration of TotalTide prediction capabilities into OEM systems. These elements are downloadable from a dedicated TotalTide SDK website.

The website contains additional information (explanatory text, code examples, data files etc) to assist developers in using the SDK and producing a TotalTide enabled application.

The SDK can be used on Windows operating systems Win98, ME, 2000, XP and NT4 SP6a. It requires IE 4.01 or later.

TotalTide SDK Overview
The TotalTide Software Development Kit (SDK) allows Original Equipment Manufacturers OEMs) to integrate TotalTide functionality with other software products. SDK based systems use exactly the same harmonic data, calculation engine and security system as the standard TotalTide product.

TotalTide supports two OEM interfaces:

TotalTide Object Model (TOM) is based on an automation interface supported by the TotalTide executable. It has been designed to provide simple, concise and logically consistent access to the prediction capabilities of TotalTide.
Low level, direct access to the calculation engine. This requires support code to read the S-57 area data files and to associate non-harmonic stations with their reference. It does not contain any search or data formatting facilities.

TotalTide needs to be installed and licensed on every end-user system.

How can I use TotalTide SDK and what constraints are there?
Authorised Developers may use the TotalTide SDK to integrate the Standard Admiralty TotalTide product with their own software applications.

Each OEM product must have the capability to install and run the full TotalTide application, as if in standalone mode, when requested to by the user; however at other times the application or Back-End Server (BES) may be run in the background.

OEMs are encouraged to use the graph control functionality provided in the SDK to generate prediction windows. However, where this facility is insufficient, OEMs may create their own GUI; in this case there should be no Admiralty branding on any windows or graphs produced. Where the application or graph routine provided in the SDK is used then the branding as used in the standard product is to be maintained.

The Developer's application must allow End Users, without the developer's intervention, to load standard TotalTide CD's in order to update TotalTide area datasets and /or revised application.

The TotalTide enabled application must employ the Admiralty TotalTide licensing and security system. This requires the application to provide the end user with access to the TotalTide Licence key wizard and enable them to import and export start up, update and activation keys in a simple manner.

TotalTide enabled products must restrict the prediction window and all copying, printing and data export to a maximum of any consecutive period of 7 days as in TotalTide. Routines to generate longer periods of prediction are not permitted.

For full details of the terms and conditions related to the use of the TotalTide SDK please click here.

How to apply
OEMs wishing to integrate TotalTide within their software should complete the application form, giving current, complete and accurate information as requested. Applicants must agree to the full terms and conditions before submitting their application. If you have any questions or concerns with regard to the terms and conditions then you must notify us either by email ttsdk@ukho.gov.uk or by contacting the UKHO Help Desk on +44 (0)1823 723366.

Cost
There is no charge for developers wishing to follow the development model outlined above. If you believe that it would be beneficial both to your company and to the UKHO to develop an application using a different model then please contact us.

Use of the TotalTide SDK Website
OEMs granted authorised developer status will be provided with a user name and password to allow access to the TotalTide SDK website. The Developer is responsible for maintaining confidentiality of this information and will notify the UKHO immediately of any unauthorised access to the TotalTide SDK facility.

The TotalTide SDK Web Site is owned and operated by Chersoft Ltd on behalf of the UK Hydrographic Office (UKHO). The material on the Site (the 'Content') is protected by Crown Copyright unless otherwise indicated. However, UKHO licences the User to retrieve and display content from the Site and store such pages in electronic form.

The Website homepage contains the most recent information on TotalTide SDK developments and links to all other areas. For those visiting the website for the first time it is suggested that initially you go to the 'About' page; this gives an overview of TotalTide SDK and provides links to other useful starter information.

Support
Developers using TotalTide SDK will be provided with an email-only support service. Support is provided free of charge. UKHO will use best endeavours to respond quickly to queries; however no guarantees of response times can be given. No other support options are offered.