Documentation

GISApi
in package

BIMworks

GISApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['exportCityGML3' => ['application/json'], 'ext...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
exportCityGML3() : SplFileObject|ErrorResponse: Operation exportCityGML3
exportCityGML3Async() : PromiseInterface: Operation exportCityGML3Async
exportCityGML3AsyncWithHttpInfo() : PromiseInterface: Operation exportCityGML3AsyncWithHttpInfo
exportCityGML3Request() : Request: Create request for operation 'exportCityGML3'
exportCityGML3WithHttpInfo() : array<string|int, mixed>: Operation exportCityGML3WithHttpInfo
extractGeoReference() : ExtractedGeoReference|ErrorResponse: Operation extractGeoReference
extractGeoReferenceAsync() : PromiseInterface: Operation extractGeoReferenceAsync
extractGeoReferenceAsyncWithHttpInfo() : PromiseInterface: Operation extractGeoReferenceAsyncWithHttpInfo
extractGeoReferenceRequest() : Request: Create request for operation 'extractGeoReference'
extractGeoReferenceWithHttpInfo() : array<string|int, mixed>: Operation extractGeoReferenceWithHttpInfo
generate3DTilesUrl() : Generate3DTilesUrl200Response|ErrorResponse: Operation generate3DTilesUrl
generate3DTilesUrlAsync() : PromiseInterface: Operation generate3DTilesUrlAsync
generate3DTilesUrlAsyncWithHttpInfo() : PromiseInterface: Operation generate3DTilesUrlAsyncWithHttpInfo
generate3DTilesUrlRequest() : Request: Create request for operation 'generate3DTilesUrl'
generate3DTilesUrlWithHttpInfo() : array<string|int, mixed>: Operation generate3DTilesUrlWithHttpInfo
getConfig() : Configuration
getFootprint() : Footprint|ErrorResponse: Operation getFootprint
getFootprintAsync() : PromiseInterface: Operation getFootprintAsync
getFootprintAsyncWithHttpInfo() : PromiseInterface: Operation getFootprintAsyncWithHttpInfo
getFootprintRequest() : Request: Create request for operation 'getFootprint'
getFootprintWithHttpInfo() : array<string|int, mixed>: Operation getFootprintWithHttpInfo
getGeoReference() : GeoReferenceResult|ErrorResponse: Operation getGeoReference
getGeoReferenceAsync() : PromiseInterface: Operation getGeoReferenceAsync
getGeoReferenceAsyncWithHttpInfo() : PromiseInterface: Operation getGeoReferenceAsyncWithHttpInfo
getGeoReferenceRequest() : Request: Create request for operation 'getGeoReference'
getGeoReferenceWithHttpInfo() : array<string|int, mixed>: Operation getGeoReferenceWithHttpInfo
getHostIndex() : int: Get the host index
setGeoReference() : void: Operation setGeoReference
setGeoReferenceAsync() : PromiseInterface: Operation setGeoReferenceAsync
setGeoReferenceAsyncWithHttpInfo() : PromiseInterface: Operation setGeoReferenceAsyncWithHttpInfo
setGeoReferenceRequest() : Request: Create request for operation 'setGeoReference'
setGeoReferenceWithHttpInfo() : array<string|int, mixed>: Operation setGeoReferenceWithHttpInfo
setHostIndex() : void: Set the host index
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['exportCityGML3' => ['application/json'], 'extractGeoReference' => ['application/json'], 'generate3DTilesUrl' => ['application/json'], 'getFootprint' => ['application/json'], 'getGeoReference' => ['application/json'], 'setGeoReference' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

exportCityGML3()

Operation exportCityGML3


    public
                    exportCityGML3(ExportCityGML3Request $export_city_gml3_request[, string $contentType = self::contentTypes['exportCityGML3'][0] ]) : SplFileObject|ErrorResponse

Export one or more IFC models to CityGML 3 or CityJSON 2

Parameters

$export_city_gml3_request : ExportCityGML3Request: export_city_gml3_request (required)
$contentType : string = self::contentTypes['exportCityGML3'][0]: The value for the Content-Type header. Check self::contentTypes['exportCityGML3'] to see the possible values for this operation

Return values

SplFileObject|ErrorResponse

exportCityGML3Async()

Operation exportCityGML3Async


    public
                    exportCityGML3Async(ExportCityGML3Request $export_city_gml3_request[, string $contentType = self::contentTypes['exportCityGML3'][0] ]) : PromiseInterface

Export one or more IFC models to CityGML 3 or CityJSON 2

Parameters

$export_city_gml3_request : ExportCityGML3Request: (required)
$contentType : string = self::contentTypes['exportCityGML3'][0]: The value for the Content-Type header. Check self::contentTypes['exportCityGML3'] to see the possible values for this operation

Return values

PromiseInterface

exportCityGML3AsyncWithHttpInfo()

Operation exportCityGML3AsyncWithHttpInfo


    public
                    exportCityGML3AsyncWithHttpInfo(ExportCityGML3Request $export_city_gml3_request[, string $contentType = self::contentTypes['exportCityGML3'][0] ]) : PromiseInterface

Export one or more IFC models to CityGML 3 or CityJSON 2

Parameters

$export_city_gml3_request : ExportCityGML3Request: (required)
$contentType : string = self::contentTypes['exportCityGML3'][0]: The value for the Content-Type header. Check self::contentTypes['exportCityGML3'] to see the possible values for this operation

Return values

PromiseInterface

exportCityGML3Request()

Create request for operation 'exportCityGML3'


    public
                    exportCityGML3Request(ExportCityGML3Request $export_city_gml3_request[, string $contentType = self::contentTypes['exportCityGML3'][0] ]) : Request

Parameters

$export_city_gml3_request : ExportCityGML3Request: (required)
$contentType : string = self::contentTypes['exportCityGML3'][0]: The value for the Content-Type header. Check self::contentTypes['exportCityGML3'] to see the possible values for this operation

Return values

Request

exportCityGML3WithHttpInfo()

Operation exportCityGML3WithHttpInfo


    public
                    exportCityGML3WithHttpInfo(ExportCityGML3Request $export_city_gml3_request[, string $contentType = self::contentTypes['exportCityGML3'][0] ]) : array<string|int, mixed>

Export one or more IFC models to CityGML 3 or CityJSON 2

Parameters

$export_city_gml3_request : ExportCityGML3Request: (required)
$contentType : string = self::contentTypes['exportCityGML3'][0]: The value for the Content-Type header. Check self::contentTypes['exportCityGML3'] to see the possible values for this operation

Return values

array<string|int, mixed> —

extractGeoReference()

Operation extractGeoReference


    public
                    extractGeoReference(ExtractGeoReferenceRequest $extract_geo_reference_request[, string $contentType = self::contentTypes['extractGeoReference'][0] ]) : ExtractedGeoReference|ErrorResponse

Compute a georeference from the model

Parameters

$extract_geo_reference_request : ExtractGeoReferenceRequest: extract_geo_reference_request (required)
$contentType : string = self::contentTypes['extractGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['extractGeoReference'] to see the possible values for this operation

Return values

ExtractedGeoReference|ErrorResponse

extractGeoReferenceAsync()

Operation extractGeoReferenceAsync


    public
                    extractGeoReferenceAsync(ExtractGeoReferenceRequest $extract_geo_reference_request[, string $contentType = self::contentTypes['extractGeoReference'][0] ]) : PromiseInterface

Compute a georeference from the model

Parameters

$extract_geo_reference_request : ExtractGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['extractGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['extractGeoReference'] to see the possible values for this operation

Return values

PromiseInterface

extractGeoReferenceAsyncWithHttpInfo()

Operation extractGeoReferenceAsyncWithHttpInfo


    public
                    extractGeoReferenceAsyncWithHttpInfo(ExtractGeoReferenceRequest $extract_geo_reference_request[, string $contentType = self::contentTypes['extractGeoReference'][0] ]) : PromiseInterface

Compute a georeference from the model

Parameters

$extract_geo_reference_request : ExtractGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['extractGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['extractGeoReference'] to see the possible values for this operation

Return values

PromiseInterface

extractGeoReferenceRequest()

Create request for operation 'extractGeoReference'


    public
                    extractGeoReferenceRequest(ExtractGeoReferenceRequest $extract_geo_reference_request[, string $contentType = self::contentTypes['extractGeoReference'][0] ]) : Request

Parameters

$extract_geo_reference_request : ExtractGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['extractGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['extractGeoReference'] to see the possible values for this operation

Return values

Request

extractGeoReferenceWithHttpInfo()

Operation extractGeoReferenceWithHttpInfo


    public
                    extractGeoReferenceWithHttpInfo(ExtractGeoReferenceRequest $extract_geo_reference_request[, string $contentType = self::contentTypes['extractGeoReference'][0] ]) : array<string|int, mixed>

Compute a georeference from the model

Parameters

$extract_geo_reference_request : ExtractGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['extractGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['extractGeoReference'] to see the possible values for this operation

Return values

array<string|int, mixed> —

generate3DTilesUrl()

Operation generate3DTilesUrl


    public
                    generate3DTilesUrl(Generate3DTilesUrlRequest $generate3_d_tiles_url_request[, string $contentType = self::contentTypes['generate3DTilesUrl'][0] ]) : Generate3DTilesUrl200Response|ErrorResponse

Create a signed 3D Tiles tileset URL for a folder or a set of versions

Parameters

$generate3_d_tiles_url_request : Generate3DTilesUrlRequest: generate3_d_tiles_url_request (required)
$contentType : string = self::contentTypes['generate3DTilesUrl'][0]: The value for the Content-Type header. Check self::contentTypes['generate3DTilesUrl'] to see the possible values for this operation

Return values

Generate3DTilesUrl200Response|ErrorResponse

generate3DTilesUrlAsync()

Operation generate3DTilesUrlAsync


    public
                    generate3DTilesUrlAsync(Generate3DTilesUrlRequest $generate3_d_tiles_url_request[, string $contentType = self::contentTypes['generate3DTilesUrl'][0] ]) : PromiseInterface

Create a signed 3D Tiles tileset URL for a folder or a set of versions

Parameters

$generate3_d_tiles_url_request : Generate3DTilesUrlRequest: (required)
$contentType : string = self::contentTypes['generate3DTilesUrl'][0]: The value for the Content-Type header. Check self::contentTypes['generate3DTilesUrl'] to see the possible values for this operation

Return values

PromiseInterface

generate3DTilesUrlAsyncWithHttpInfo()

Operation generate3DTilesUrlAsyncWithHttpInfo


    public
                    generate3DTilesUrlAsyncWithHttpInfo(Generate3DTilesUrlRequest $generate3_d_tiles_url_request[, string $contentType = self::contentTypes['generate3DTilesUrl'][0] ]) : PromiseInterface

Create a signed 3D Tiles tileset URL for a folder or a set of versions

Parameters

$generate3_d_tiles_url_request : Generate3DTilesUrlRequest: (required)
$contentType : string = self::contentTypes['generate3DTilesUrl'][0]: The value for the Content-Type header. Check self::contentTypes['generate3DTilesUrl'] to see the possible values for this operation

Return values

PromiseInterface

generate3DTilesUrlRequest()

Create request for operation 'generate3DTilesUrl'


    public
                    generate3DTilesUrlRequest(Generate3DTilesUrlRequest $generate3_d_tiles_url_request[, string $contentType = self::contentTypes['generate3DTilesUrl'][0] ]) : Request

Parameters

$generate3_d_tiles_url_request : Generate3DTilesUrlRequest: (required)
$contentType : string = self::contentTypes['generate3DTilesUrl'][0]: The value for the Content-Type header. Check self::contentTypes['generate3DTilesUrl'] to see the possible values for this operation

Return values

Request

generate3DTilesUrlWithHttpInfo()

Operation generate3DTilesUrlWithHttpInfo


    public
                    generate3DTilesUrlWithHttpInfo(Generate3DTilesUrlRequest $generate3_d_tiles_url_request[, string $contentType = self::contentTypes['generate3DTilesUrl'][0] ]) : array<string|int, mixed>

Create a signed 3D Tiles tileset URL for a folder or a set of versions

Parameters

$generate3_d_tiles_url_request : Generate3DTilesUrlRequest: (required)
$contentType : string = self::contentTypes['generate3DTilesUrl'][0]: The value for the Content-Type header. Check self::contentTypes['generate3DTilesUrl'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getFootprint()

Operation getFootprint


    public
                    getFootprint(GetFootprintRequest $get_footprint_request[, string $contentType = self::contentTypes['getFootprint'][0] ]) : Footprint|ErrorResponse

The footprint of a model on the map (deprecated)

Parameters

$get_footprint_request : GetFootprintRequest: get_footprint_request (required)
$contentType : string = self::contentTypes['getFootprint'][0]: The value for the Content-Type header. Check self::contentTypes['getFootprint'] to see the possible values for this operation

Return values

Footprint|ErrorResponse

getFootprintAsync()

Operation getFootprintAsync


    public
                    getFootprintAsync(GetFootprintRequest $get_footprint_request[, string $contentType = self::contentTypes['getFootprint'][0] ]) : PromiseInterface

The footprint of a model on the map (deprecated)

Parameters

$get_footprint_request : GetFootprintRequest: (required)
$contentType : string = self::contentTypes['getFootprint'][0]: The value for the Content-Type header. Check self::contentTypes['getFootprint'] to see the possible values for this operation

Return values

PromiseInterface

getFootprintAsyncWithHttpInfo()

Operation getFootprintAsyncWithHttpInfo


    public
                    getFootprintAsyncWithHttpInfo(GetFootprintRequest $get_footprint_request[, string $contentType = self::contentTypes['getFootprint'][0] ]) : PromiseInterface

The footprint of a model on the map (deprecated)

Parameters

$get_footprint_request : GetFootprintRequest: (required)
$contentType : string = self::contentTypes['getFootprint'][0]: The value for the Content-Type header. Check self::contentTypes['getFootprint'] to see the possible values for this operation

Return values

PromiseInterface

getFootprintRequest()

Create request for operation 'getFootprint'


    public
                    getFootprintRequest(GetFootprintRequest $get_footprint_request[, string $contentType = self::contentTypes['getFootprint'][0] ]) : Request

Parameters

$get_footprint_request : GetFootprintRequest: (required)
$contentType : string = self::contentTypes['getFootprint'][0]: The value for the Content-Type header. Check self::contentTypes['getFootprint'] to see the possible values for this operation

Return values

Request

getFootprintWithHttpInfo()

Operation getFootprintWithHttpInfo


    public
                    getFootprintWithHttpInfo(GetFootprintRequest $get_footprint_request[, string $contentType = self::contentTypes['getFootprint'][0] ]) : array<string|int, mixed>

The footprint of a model on the map (deprecated)

Parameters

$get_footprint_request : GetFootprintRequest: (required)
$contentType : string = self::contentTypes['getFootprint'][0]: The value for the Content-Type header. Check self::contentTypes['getFootprint'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getGeoReference()

Operation getGeoReference


    public
                    getGeoReference([GetGeoReferenceRequest|null $get_geo_reference_request = null ][, string $contentType = self::contentTypes['getGeoReference'][0] ]) : GeoReferenceResult|ErrorResponse

Read or convert a georeference

Parameters

$get_geo_reference_request : GetGeoReferenceRequest|null = null: get_geo_reference_request (optional)
$contentType : string = self::contentTypes['getGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['getGeoReference'] to see the possible values for this operation

Return values

GeoReferenceResult|ErrorResponse

getGeoReferenceAsync()

Operation getGeoReferenceAsync


    public
                    getGeoReferenceAsync([GetGeoReferenceRequest|null $get_geo_reference_request = null ][, string $contentType = self::contentTypes['getGeoReference'][0] ]) : PromiseInterface

Read or convert a georeference

Parameters

$get_geo_reference_request : GetGeoReferenceRequest|null = null: (optional)
$contentType : string = self::contentTypes['getGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['getGeoReference'] to see the possible values for this operation

Return values

PromiseInterface

getGeoReferenceAsyncWithHttpInfo()

Operation getGeoReferenceAsyncWithHttpInfo


    public
                    getGeoReferenceAsyncWithHttpInfo([GetGeoReferenceRequest|null $get_geo_reference_request = null ][, string $contentType = self::contentTypes['getGeoReference'][0] ]) : PromiseInterface

Read or convert a georeference

Parameters

$get_geo_reference_request : GetGeoReferenceRequest|null = null: (optional)
$contentType : string = self::contentTypes['getGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['getGeoReference'] to see the possible values for this operation

Return values

PromiseInterface

getGeoReferenceRequest()

Create request for operation 'getGeoReference'


    public
                    getGeoReferenceRequest([GetGeoReferenceRequest|null $get_geo_reference_request = null ][, string $contentType = self::contentTypes['getGeoReference'][0] ]) : Request

Parameters

$get_geo_reference_request : GetGeoReferenceRequest|null = null: (optional)
$contentType : string = self::contentTypes['getGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['getGeoReference'] to see the possible values for this operation

Return values

Request

getGeoReferenceWithHttpInfo()

Operation getGeoReferenceWithHttpInfo


    public
                    getGeoReferenceWithHttpInfo([GetGeoReferenceRequest|null $get_geo_reference_request = null ][, string $contentType = self::contentTypes['getGeoReference'][0] ]) : array<string|int, mixed>

Read or convert a georeference

Parameters

$get_geo_reference_request : GetGeoReferenceRequest|null = null: (optional)
$contentType : string = self::contentTypes['getGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['getGeoReference'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

setGeoReference()

Operation setGeoReference


    public
                    setGeoReference(SetGeoReferenceRequest $set_geo_reference_request[, string $contentType = self::contentTypes['setGeoReference'][0] ]) : void

Store a Version's georeference

Parameters

$set_geo_reference_request : SetGeoReferenceRequest: set_geo_reference_request (required)
$contentType : string = self::contentTypes['setGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['setGeoReference'] to see the possible values for this operation

setGeoReferenceAsync()

Operation setGeoReferenceAsync


    public
                    setGeoReferenceAsync(SetGeoReferenceRequest $set_geo_reference_request[, string $contentType = self::contentTypes['setGeoReference'][0] ]) : PromiseInterface

Store a Version's georeference

Parameters

$set_geo_reference_request : SetGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['setGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['setGeoReference'] to see the possible values for this operation

Return values

PromiseInterface

setGeoReferenceAsyncWithHttpInfo()

Operation setGeoReferenceAsyncWithHttpInfo


    public
                    setGeoReferenceAsyncWithHttpInfo(SetGeoReferenceRequest $set_geo_reference_request[, string $contentType = self::contentTypes['setGeoReference'][0] ]) : PromiseInterface

Store a Version's georeference

Parameters

$set_geo_reference_request : SetGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['setGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['setGeoReference'] to see the possible values for this operation

Return values

PromiseInterface

setGeoReferenceRequest()

Create request for operation 'setGeoReference'


    public
                    setGeoReferenceRequest(SetGeoReferenceRequest $set_geo_reference_request[, string $contentType = self::contentTypes['setGeoReference'][0] ]) : Request

Parameters

$set_geo_reference_request : SetGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['setGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['setGeoReference'] to see the possible values for this operation

Return values

Request

setGeoReferenceWithHttpInfo()

Operation setGeoReferenceWithHttpInfo


    public
                    setGeoReferenceWithHttpInfo(SetGeoReferenceRequest $set_geo_reference_request[, string $contentType = self::contentTypes['setGeoReference'][0] ]) : array<string|int, mixed>

Store a Version's georeference

Parameters

$set_geo_reference_request : SetGeoReferenceRequest: (required)
$contentType : string = self::contentTypes['setGeoReference'][0]: The value for the Content-Type header. Check self::contentTypes['setGeoReference'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

GISApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

exportCityGML3()

Parameters

Tags

Return values

exportCityGML3Async()

Parameters

Tags

Return values

exportCityGML3AsyncWithHttpInfo()

Parameters

Tags

Return values

exportCityGML3Request()

Parameters

Tags

Return values

exportCityGML3WithHttpInfo()

Parameters

Tags

Return values

extractGeoReference()

Parameters

Tags

Return values

extractGeoReferenceAsync()

Parameters

Tags

Return values

extractGeoReferenceAsyncWithHttpInfo()

Parameters

Tags

Return values

extractGeoReferenceRequest()

Parameters

Tags

Return values

extractGeoReferenceWithHttpInfo()

Parameters

Tags

Return values

generate3DTilesUrl()

Parameters

Tags

Return values

generate3DTilesUrlAsync()

Parameters

Tags

Return values

generate3DTilesUrlAsyncWithHttpInfo()

Parameters

Tags

Return values

generate3DTilesUrlRequest()

Parameters

Tags

Return values

generate3DTilesUrlWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getFootprint()

Parameters

GISApi
in package

BIMworks