VMDFileCollection

@interface VMDFileCollection : NSObject

A collection of venue map data files

Since

1.1

Public Properties

  • The VMD XML file

    Declaration

    Swift

    @property (readwrite, strong, nonatomic) id<VMDFile> mapXmlFile;

  • The VMD GeoJSON file

    Declaration

    Swift

    @property (readwrite, strong, nonatomic) id<VMDFile> mapGeojsonFile;

  • The VMD custom map info json file

    Declaration

    Swift

    @property (readwrite, strong, nonatomic) id<VMDFile> customMapInfoJsonFile;

  • Zip file contiaing other map files

    Declaration

    Swift

    @property (readwrite, strong, nonatomic) id<VMDFile> mapZipFile;

  • Legacy

    Since

    1.3

    Declaration

    Swift

    @property (readwrite, strong, nonatomic) id<VMDFile> sitemapXmlFile;

  • Legacy

    Since

    1.3

    Declaration

    Swift

    @property (readwrite, strong, nonatomic)
    NSDictionary<NSString *, id<VMDFile>> *buildingXmlFiles;

Initializers

  • Create file collection with individual xml, geojson, and custom map info

    Declaration

    Swift

    - (instancetype)initWithMapXmlFile:(id<VMDFile>)mapXmlFile
                    mapGeojsonFile:(id<VMDFile>)mapGeojsonFile
             customMapInfoJsonFile:(id<VMDFile>)customMapInfoJsonFile;

    Parameters

    mapXmlFile

    xml file
    mapGeojsonFile

    geojson file
    customMapInfoJsonFile

    custom map info file

    Return Value

    a file collection

  • Create file colleciton with XML and geojson only

    Declaration

    Swift

    - (instancetype)initWithMapXmlFile:(id<VMDFile>)mapXmlFile
                    mapGeojsonFile:(id<VMDFile>)mapGeojsonFile;

    Parameters

    mapXmlFile

    the xml file
    mapGeojsonFile

    the geojson file

    Return Value

    a file collection

  • Create file collection using root directory containing VMD map files. The names of the files are expected to be:

    • map.xml
    • map.geojson

    • customMapInfo.json

    Declaration

    Swift

    - (instancetype)initWithBaseDirectory:(NSString *)baseDirectory;

    Parameters

    baseDirectory

    the root directory

    Return Value

    a file collection

  • Create file collection using a root URL that can be used to build URLs for other VMD files. The names of the files are expected to be:

    • map.xml
    • map.geojson

    • customMapInfo.json

    Declaration

    Swift

    - (instancetype)initWithBaseUrl:(NSURL *)baseUrl;

    Parameters

    baseUrl

    the base url

    Return Value

    a file collection

  • Create file colleciton using a zip file containing other VMD files. The names of the files are expecte to be:

    • map.xml
    • map.geojson

    • customMapInfo.json

    Declaration

    Swift

    - (instancetype)initWithBaseZipFile:(id<VMDFile>)mapZipFile;

    Parameters

    mapZipFile

    the zip file

    Return Value

    a file collection

  • Unzip vmd files from zip file to the specified path

    Declaration

    Swift

    - (BOOL)unzipFilesAtPath:(NSString *)zipPath;

    Parameters

    zipPath

    the location to unzip files to