Documentation

Footprint
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

Footprint Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR : mixed = null

Properties

$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$openAPIFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$openAPIModelName : string: The original name of the model.
$openAPINullables : array<string|int, bool>: Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull : array<string|int, bool>: If a nullable field gets set to null, insert it here
$openAPITypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)

Methods

__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getAnchorPoint() : GeoPoint|null: Gets anchor_point
getAreaM2() : float|null: Gets area_m2
getCutMm() : float|null: Gets cut_mm
getGeojson() : object|null: Gets geojson
getGeoReference() : GeoReference|null: Gets geo_reference
getModelName() : string: The original name of the model.
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getWkt() : string|null: Gets wkt
getZeroPoint() : GeoPoint|null: Gets zero_point
isNullable() : bool: Checks if a property is nullable
isNullableSetToNull() : bool: Checks if a nullable property is set to null.
jsonSerialize() : mixed: Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed|null: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
openAPIFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
openAPITypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
setAnchorPoint() : self: Sets anchor_point
setAreaM2() : self: Sets area_m2
setCutMm() : self: Sets cut_mm
setGeojson() : self: Sets geojson
setGeoReference() : self: Sets geo_reference
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setWkt() : self: Sets wkt
setZeroPoint() : self: Sets zero_point
toHeaderValue() : string: Gets a header-safe presentation of the object
valid() : bool: Validate all the properties in the model return true if all passed
openAPINullables() : array<string|int, mixed>: Array of nullable properties
getOpenAPINullablesSetToNull() : array<string|int, bool>: Array of nullable field names deliberately set to null
setIfExists() : void: Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull() : void: Setter - Array of nullable field names deliberately set to null

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


        protected
        static    array<string|int, string>
    $attributeMap
     = ['wkt' => 'wkt', 'geojson' => 'geojson', 'geo_reference' => 'geo_reference', 'anchor_point' => 'anchor_point', 'zero_point' => 'zero_point', 'area_m2' => 'area_m2', 'cut_mm' => 'cut_mm']

$container

Associative array for storing property values


        protected
            array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


        protected
        static    array<string|int, string>
    $getters
     = ['wkt' => 'getWkt', 'geojson' => 'getGeojson', 'geo_reference' => 'getGeoReference', 'anchor_point' => 'getAnchorPoint', 'zero_point' => 'getZeroPoint', 'area_m2' => 'getAreaM2', 'cut_mm' => 'getCutMm']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['wkt' => null, 'geojson' => null, 'geo_reference' => null, 'anchor_point' => null, 'zero_point' => null, 'area_m2' => null, 'cut_mm' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'Footprint'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['wkt' => false, 'geojson' => false, 'geo_reference' => false, 'anchor_point' => false, 'zero_point' => false, 'area_m2' => false, 'cut_mm' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here


        protected
            array<string|int, bool>
    $openAPINullablesSetToNull
     = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization


        protected
        static    array<string|int, string>
    $openAPITypes
     = ['wkt' => 'string', 'geojson' => 'object', 'geo_reference' => '\BIMworks\Model\GeoReference', 'anchor_point' => '\BIMworks\Model\GeoPoint', 'zero_point' => '\BIMworks\Model\GeoPoint', 'area_m2' => 'float', 'cut_mm' => 'float']

$setters

Array of attributes to setter functions (for deserialization of responses)


        protected
        static    array<string|int, string>
    $setters
     = ['wkt' => 'setWkt', 'geojson' => 'setGeojson', 'geo_reference' => 'setGeoReference', 'anchor_point' => 'setAnchorPoint', 'zero_point' => 'setZeroPoint', 'area_m2' => 'setAreaM2', 'cut_mm' => 'setCutMm']

__construct()

Constructor


    public
                    __construct([array<string|int, mixed>|null $data = null ]) : mixed

Parameters

$data : array<string|int, mixed>|null = null: Associated array of property values initializing the model

__toString()

Gets the string presentation of the object


    public
                    __toString() : string

Return values

string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static        attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed>

getAnchorPoint()

Gets anchor_point


    public
                    getAnchorPoint() : GeoPoint|null

Return values

GeoPoint|null

getAreaM2()

Gets area_m2


    public
                    getAreaM2() : float|null

Return values

float|null

getCutMm()

Gets cut_mm


    public
                    getCutMm() : float|null

Return values

float|null

getGeojson()

Gets geojson


    public
                    getGeojson() : object|null

Return values

object|null

getGeoReference()

Gets geo_reference


    public
                    getGeoReference() : GeoReference|null

Return values

GeoReference|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static        getters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getWkt()

Gets wkt


    public
                    getWkt() : string|null

Return values

string|null

getZeroPoint()

Gets zero_point


    public
                    getZeroPoint() : GeoPoint|null

Return values

GeoPoint|null

isNullable()

Checks if a property is nullable


    public
            static        isNullable(string $property) : bool

Parameters

$property : string

Return values

bool

isNullableSetToNull()

Checks if a nullable property is set to null.


    public
                    isNullableSetToNull(string $property) : bool

Parameters

$property : string

Return values

bool

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().


    public
                    jsonSerialize() : mixed

Return values

mixed —

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                    listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                    offsetExists(int|string $offset) : bool

Parameters

$offset : int|string: Offset

Return values

bool

offsetGet()

Gets offset.


    public
                    offsetGet(int|string $offset) : mixed|null

Parameters

$offset : int|string: Offset

#[ReturnTypeWillChange]

Return values

mixed|null

offsetSet()

Sets value based on offset.


    public
                    offsetSet(int|null $offset, mixed $value) : void

Parameters

$offset : int|null: Offset
$value : mixed: Value to be set

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int|string $offset) : void

Parameters

$offset : int|string: Offset

openAPIFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static        openAPIFormats() : array<string|int, mixed>

Return values

array<string|int, mixed>

openAPITypes()

Array of property to type mappings. Used for (de)serialization


    public
            static        openAPITypes() : array<string|int, mixed>

Return values

array<string|int, mixed>

setAnchorPoint()

Sets anchor_point


    public
                    setAnchorPoint(GeoPoint|null $anchor_point) : self

Parameters

$anchor_point : GeoPoint|null: The centre of the model's bounds on the map

Return values

self

setAreaM2()

Sets area_m2


    public
                    setAreaM2(float|null $area_m2) : self

Parameters

$area_m2 : float|null: SLICE only

Return values

self

setCutMm()

Sets cut_mm


    public
                    setCutMm(float|null $cut_mm) : self

Parameters

$cut_mm : float|null: SLICE only

Return values

self

setGeojson()

Sets geojson


    public
                    setGeojson(object|null $geojson) : self

Parameters

$geojson : object|null: The same outline as a GeoJSON geometry (RFC 7946), its coordinates [longitude, latitude] in WGS84

Return values

self

setGeoReference()

Sets geo_reference


    public
                    setGeoReference(GeoReference|null $geo_reference) : self

Parameters

$geo_reference : GeoReference|null: geo_reference

Return values

self

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static        setters() : array<string|int, mixed>

Return values

array<string|int, mixed>

setWkt()

Sets wkt


    public
                    setWkt(string|null $wkt) : self

Parameters

$wkt : string|null: The outline, WKT in WGS84 (longitude latitude)

Return values

self

setZeroPoint()

Sets zero_point


    public
                    setZeroPoint(GeoPoint|null $zero_point) : self

Parameters

$zero_point : GeoPoint|null: The model's origin on the map

Return values

self

toHeaderValue()

Gets a header-safe presentation of the object


    public
                    toHeaderValue() : string

Return values

string

valid()

Validate all the properties in the model return true if all passed


    public
                    valid() : bool

Return values

bool —

True if all properties are valid

openAPINullables()

Array of nullable properties


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

Return values

array<string|int, mixed>

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null


    private
                    getOpenAPINullablesSetToNull() : array<string|int, bool>

Return values

array<string|int, bool>

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array


    private
                    setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void

Parameters

$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null


    private
                    setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void

Parameters

$openAPINullablesSetToNull : array<string|int, bool>

Footprint in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getAnchorPoint()

Return values

getAreaM2()

Return values

getCutMm()

Return values

getGeojson()

Return values

getGeoReference()

Return values

getModelName()

Return values

getters()

Return values

getWkt()

Return values

getZeroPoint()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

openAPITypes()

Return values

setAnchorPoint()

Parameters

Return values

setAreaM2()

Parameters

Return values

setCutMm()

Parameters

Footprint
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable