CityGML3ExportLod
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CityGML3ExportLod Class Doc Comment
Tags
Table of Contents
Interfaces
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Constants
- DISCRIMINATOR = 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
- getBuilding() : CityGML3ExportType|null
- Gets building
- getBuildingConstructiveElement() : CityGML3ExportType|null
- Gets building_constructive_element
- getBuildingInstallation() : CityGML3ExportType|null
- Gets building_installation
- getBuildingRoom() : CityGML3ExportType|null
- Gets building_room
- getBuildingUnit() : CityGML3ExportType|null
- Gets building_unit
- getDoor() : CityGML3ExportType|null
- Gets door
- getFloorSurface() : CityGML3ExportType|null
- Gets floor_surface
- getLandUse() : CityGML3ExportType|null
- Gets land_use
- getModelName() : string
- The original name of the model.
- getRoofSurface() : CityGML3ExportType|null
- Gets roof_surface
- getStorey() : CityGML3ExportType|null
- Gets storey
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWall() : CityGML3ExportType|null
- Gets wall
- getWallSurface() : CityGML3ExportType|null
- Gets wall_surface
- getWindow() : CityGML3ExportType|null
- Gets window
- 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
- setBuilding() : self
- Sets building
- setBuildingConstructiveElement() : self
- Sets building_constructive_element
- setBuildingInstallation() : self
- Sets building_installation
- setBuildingRoom() : self
- Sets building_room
- setBuildingUnit() : self
- Sets building_unit
- setDoor() : self
- Sets door
- setFloorSurface() : self
- Sets floor_surface
- setLandUse() : self
- Sets land_use
- setRoofSurface() : self
- Sets roof_surface
- setStorey() : self
- Sets storey
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWall() : self
- Sets wall
- setWallSurface() : self
- Sets wall_surface
- setWindow() : self
- Sets window
- 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
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$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
= ['land_use' => 'landUse', 'building' => 'building', 'storey' => 'storey', 'building_room' => 'buildingRoom', 'building_unit' => 'buildingUnit', 'building_constructive_element' => 'buildingConstructiveElement', 'door' => 'door', 'window' => 'window', 'building_installation' => 'buildingInstallation', 'wall_surface' => 'wallSurface', 'floor_surface' => 'floorSurface', 'roof_surface' => 'roofSurface', 'wall' => 'wall']
$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
= ['land_use' => 'getLandUse', 'building' => 'getBuilding', 'storey' => 'getStorey', 'building_room' => 'getBuildingRoom', 'building_unit' => 'getBuildingUnit', 'building_constructive_element' => 'getBuildingConstructiveElement', 'door' => 'getDoor', 'window' => 'getWindow', 'building_installation' => 'getBuildingInstallation', 'wall_surface' => 'getWallSurface', 'floor_surface' => 'getFloorSurface', 'roof_surface' => 'getRoofSurface', 'wall' => 'getWall']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['land_use' => null, 'building' => null, 'storey' => null, 'building_room' => null, 'building_unit' => null, 'building_constructive_element' => null, 'door' => null, 'window' => null, 'building_installation' => null, 'wall_surface' => null, 'floor_surface' => null, 'roof_surface' => null, 'wall' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CityGML3ExportLod'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, bool>
$openAPINullables
= ['land_use' => false, 'building' => false, 'storey' => false, 'building_room' => false, 'building_unit' => false, 'building_constructive_element' => false, 'door' => false, 'window' => false, 'building_installation' => false, 'wall_surface' => false, 'floor_surface' => false, 'roof_surface' => false, 'wall' => 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
= ['land_use' => '\BIMworks\Model\CityGML3ExportType', 'building' => '\BIMworks\Model\CityGML3ExportType', 'storey' => '\BIMworks\Model\CityGML3ExportType', 'building_room' => '\BIMworks\Model\CityGML3ExportType', 'building_unit' => '\BIMworks\Model\CityGML3ExportType', 'building_constructive_element' => '\BIMworks\Model\CityGML3ExportType', 'door' => '\BIMworks\Model\CityGML3ExportType', 'window' => '\BIMworks\Model\CityGML3ExportType', 'building_installation' => '\BIMworks\Model\CityGML3ExportType', 'wall_surface' => '\BIMworks\Model\CityGML3ExportType', 'floor_surface' => '\BIMworks\Model\CityGML3ExportType', 'roof_surface' => '\BIMworks\Model\CityGML3ExportType', 'wall' => '\BIMworks\Model\CityGML3ExportType']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['land_use' => 'setLandUse', 'building' => 'setBuilding', 'storey' => 'setStorey', 'building_room' => 'setBuildingRoom', 'building_unit' => 'setBuildingUnit', 'building_constructive_element' => 'setBuildingConstructiveElement', 'door' => 'setDoor', 'window' => 'setWindow', 'building_installation' => 'setBuildingInstallation', 'wall_surface' => 'setWallSurface', 'floor_surface' => 'setFloorSurface', 'roof_surface' => 'setRoofSurface', 'wall' => 'setWall']
Methods
__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
stringattributeMap()
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>getBuilding()
Gets building
public
getBuilding() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetBuildingConstructiveElement()
Gets building_constructive_element
public
getBuildingConstructiveElement() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetBuildingInstallation()
Gets building_installation
public
getBuildingInstallation() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetBuildingRoom()
Gets building_room
public
getBuildingRoom() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetBuildingUnit()
Gets building_unit
public
getBuildingUnit() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetDoor()
Gets door
public
getDoor() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetFloorSurface()
Gets floor_surface
public
getFloorSurface() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetLandUse()
Gets land_use
public
getLandUse() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetRoofSurface()
Gets roof_surface
public
getRoofSurface() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetStorey()
Gets storey
public
getStorey() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>getWall()
Gets wall
public
getWall() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetWallSurface()
Gets wall_surface
public
getWallSurface() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullgetWindow()
Gets window
public
getWindow() : CityGML3ExportType|null
Return values
CityGML3ExportType|nullisNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
boolisNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
booljsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
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
booloffsetGet()
Gets offset.
public
offsetGet(int|string $offset) : mixed|null
Parameters
- $offset : int|string
-
Offset
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|nulloffsetSet()
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>setBuilding()
Sets building
public
setBuilding(CityGML3ExportType|null $building) : self
Parameters
- $building : CityGML3ExportType|null
-
building
Return values
selfsetBuildingConstructiveElement()
Sets building_constructive_element
public
setBuildingConstructiveElement(CityGML3ExportType|null $building_constructive_element) : self
Parameters
- $building_constructive_element : CityGML3ExportType|null
-
building_constructive_element
Return values
selfsetBuildingInstallation()
Sets building_installation
public
setBuildingInstallation(CityGML3ExportType|null $building_installation) : self
Parameters
- $building_installation : CityGML3ExportType|null
-
building_installation
Return values
selfsetBuildingRoom()
Sets building_room
public
setBuildingRoom(CityGML3ExportType|null $building_room) : self
Parameters
- $building_room : CityGML3ExportType|null
-
building_room
Return values
selfsetBuildingUnit()
Sets building_unit
public
setBuildingUnit(CityGML3ExportType|null $building_unit) : self
Parameters
- $building_unit : CityGML3ExportType|null
-
building_unit
Return values
selfsetDoor()
Sets door
public
setDoor(CityGML3ExportType|null $door) : self
Parameters
- $door : CityGML3ExportType|null
-
door
Return values
selfsetFloorSurface()
Sets floor_surface
public
setFloorSurface(CityGML3ExportType|null $floor_surface) : self
Parameters
- $floor_surface : CityGML3ExportType|null
-
floor_surface
Return values
selfsetLandUse()
Sets land_use
public
setLandUse(CityGML3ExportType|null $land_use) : self
Parameters
- $land_use : CityGML3ExportType|null
-
land_use
Return values
selfsetRoofSurface()
Sets roof_surface
public
setRoofSurface(CityGML3ExportType|null $roof_surface) : self
Parameters
- $roof_surface : CityGML3ExportType|null
-
roof_surface
Return values
selfsetStorey()
Sets storey
public
setStorey(CityGML3ExportType|null $storey) : self
Parameters
- $storey : CityGML3ExportType|null
-
storey
Return values
selfsetters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>setWall()
Sets wall
public
setWall(CityGML3ExportType|null $wall) : self
Parameters
- $wall : CityGML3ExportType|null
-
wall
Return values
selfsetWallSurface()
Sets wall_surface
public
setWallSurface(CityGML3ExportType|null $wall_surface) : self
Parameters
- $wall_surface : CityGML3ExportType|null
-
wall_surface
Return values
selfsetWindow()
Sets window
public
setWindow(CityGML3ExportType|null $window) : self
Parameters
- $window : CityGML3ExportType|null
-
window
Return values
selftoHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
stringvalid()
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>