Documentation

GISApi
in package

GISApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  = ['exportCityGML3' => ['application/json']]

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
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

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

Properties

$client

protected ClientInterface $client

$hostIndex

protected int $hostIndex

Host index

Methods

__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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
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

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

Tags
throws
InvalidArgumentException
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

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

Tags
throws
InvalidArgumentException
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

Tags
throws
InvalidArgumentException
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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \SplFileObject|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

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>
Tags
throws
RuntimeException

on file opening failure

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results