address.h

Go to the documentation of this file.

/*
 * address.h
 *
 *  Created on: 31 May 2018
 *      Author: billy
 */
 
#ifndef TOOLS_GRASSROOTS_GEOCODER_INCLUDE_ADDRESS_H_
#define TOOLS_GRASSROOTS_GEOCODER_INCLUDE_ADDRESS_H_
 
#include "grassroots_geocoder_library.h"
#include "coordinate.h"
#include "jansson.h"
 
typedef struct Address
{
  char *ad_name_s;
 
  char *ad_street_s;
 
 
  char *ad_town_s;
 
 
  char *ad_county_s;
 
  char *ad_country_s;
 
  char *ad_postcode_s;
 
  char *ad_country_code_s;
 
  char *ad_gps_s;
 
  Coordinate *ad_gps_centre_p;
 
 
  Coordinate *ad_gps_north_east_p;
 
 
  Coordinate *ad_gps_south_west_p;
 
  double64 *ad_elevation_p;
} Address;
 
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_ADDRESS_TAGS
  #define ADDRESS_PREFIX GRASSROOTS_GEOCODER_API
  #define ADDRESS_VAL(x)  = x
#else
  #define ADDRESS_PREFIX extern GRASSROOTS_GEOCODER_API
  #define ADDRESS_VAL(x)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
 
 
 
 
 
ADDRESS_PREFIX const char *AD_ADDRESS_S ADDRESS_VAL ("Address");
 
ADDRESS_PREFIX const char *AD_NAME_S ADDRESS_VAL ("name");
 
 
ADDRESS_PREFIX const char *AD_POSTCODE_S ADDRESS_VAL ("postalCode");
 
 
ADDRESS_PREFIX const char *AD_STREET_S ADDRESS_VAL ("streetAddress");
 
ADDRESS_PREFIX const char *AD_TOWN_S ADDRESS_VAL ("addressLocality");
 
 
ADDRESS_PREFIX const char *AD_COUNTY_S ADDRESS_VAL ("addressRegion");
 
 
ADDRESS_PREFIX const char *AD_COUNTRY_S ADDRESS_VAL ("addressCountry");
 
 
 
ADDRESS_PREFIX const char *AD_LOCATION_S ADDRESS_VAL ("location");
 
 
ADDRESS_PREFIX const char *AD_CENTRE_LOCATION_S ADDRESS_VAL ("centre");
 
ADDRESS_PREFIX const char *AD_NORTH_EAST_LOCATION_S ADDRESS_VAL ("north_east_bound");
 
 
ADDRESS_PREFIX const char *AD_SOUTH_WEST_LOCATION_S ADDRESS_VAL ("south_west_bound");
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
GRASSROOTS_GEOCODER_API Address *AllocateAddress (const char *name_s, const char *street_s, const char *town_s, const char *county_s, const char *country_s, const char *postcode_s, const char *country_code_s, const char *gps_s);
 
 
GRASSROOTS_GEOCODER_API void FreeAddress (Address *address_p);
 
 
GRASSROOTS_GEOCODER_API void ClearAddress (Address *address_p);
 
 
GRASSROOTS_GEOCODER_API char *GetAddressAsString (const Address *address_p);
 
 
GRASSROOTS_GEOCODER_API char *GetAddressAsDelimitedString (const Address *address_p, const char *sep_s);
 
 
GRASSROOTS_GEOCODER_API json_t *GetAddressAsJSON (const Address *address_p);
 
 
GRASSROOTS_GEOCODER_API Address *GetAddressFromJSON (const json_t *address_json_p);
 
GRASSROOTS_GEOCODER_API bool ConvertAddressToJSON (const Address *address_p, json_t *dest_p);
 
 
GRASSROOTS_GEOCODER_API bool ParseAddressForSchemaOrg (const Address *address_p, json_t *values_p, const char *address_key_s);
 
 
GRASSROOTS_GEOCODER_API Address *ParseSchemaOrgAddress (const json_t *values_p, const char *address_key_s);
 
 
GRASSROOTS_GEOCODER_API bool SetAddressCentreCoordinate (Address *address_p, const double64 latitude, const double64 longitude, const double64 *elevation_p);
 
 
GRASSROOTS_GEOCODER_API bool SetAddressNorthEastCoordinate (Address *address_p, const double64 latitude, const double64 longitude, const double64 *elevation_p);
 
 
GRASSROOTS_GEOCODER_API bool SetAddressSouthWestCoordinate (Address *address_p, const double64 latitude, const double64 longitude, const double64 *elevation_p);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* TOOLS_GRASSROOTS_GEOCODER_INCLUDE_ADDRESS_H_ */