Documentation

OverlayPathItem
in package
implements ModelInterface, ArrayAccess, JsonSerializable

OverlayPathItem Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DEPTH_ALWAYS  : mixed = 'always'
DEPTH_GHOST  : mixed = 'ghost'
DEPTH_TEST  : mixed = 'test'
DISCRIMINATOR  : mixed = null
LABEL_SHOW_ALWAYS  : mixed = 'always'
LABEL_SHOW_HOVER  : mixed = 'hover'
ROLE_AREA  : mixed = 'area'
ROLE_HAZARD  : mixed = 'hazard'
ROLE_INFO  : mixed = 'info'
ROLE_NEUTRAL  : mixed = 'neutral'
ROLE_OK  : mixed = 'ok'
ROLE_ROUTE  : mixed = 'route'
ROLE_WARNING  : mixed = 'warning'
VIEWS__2D  : mixed = '2d'
VIEWS__3D  : mixed = '3d'

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
getArrows()  : OverlayPathItemAllOfArrows|null
Gets arrows
getColor()  : string|null
Gets color
getDepth()  : string|null
Gets depth
getDepthAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDirected()  : bool|null
Gets directed
getId()  : string
Gets id
getLabel()  : string|null
Gets label
getLabelShow()  : string|null
Gets label_show
getLabelShowAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getLift()  : float|null
Gets lift
getMarks()  : array<string|int, OverlayPathItemAllOfMarks>|null
Gets marks
getModelName()  : string
The original name of the model.
getPoints()  : array<string|int, float>
Gets points
getQids()  : array<string|int, string>|null
Gets qids
getRole()  : string|null
Gets role
getRoleAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSegmentRoles()  : array<string|int, array<string|int, mixed>>|null
Gets segment_roles
getStations()  : OverlayPathItemAllOfStations|null
Gets stations
getStorey()  : string|null
Gets storey
getStyle()  : OverlayPathItemAllOfStyle|null
Gets style
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTooltip()  : string|null
Gets tooltip
getType()  : string
Gets type
getViews()  : array<string|int, string>|null
Gets views
getViewsAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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
setArrows()  : self
Sets arrows
setColor()  : self
Sets color
setDepth()  : self
Sets depth
setDirected()  : self
Sets directed
setId()  : self
Sets id
setLabel()  : self
Sets label
setLabelShow()  : self
Sets label_show
setLift()  : self
Sets lift
setMarks()  : self
Sets marks
setPoints()  : self
Sets points
setQids()  : self
Sets qids
setRole()  : self
Sets role
setSegmentRoles()  : self
Sets segment_roles
setStations()  : self
Sets stations
setStorey()  : self
Sets storey
setStyle()  : self
Sets style
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTooltip()  : self
Sets tooltip
setType()  : self
Sets type
setViews()  : self
Sets views
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

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 = ['type' => 'type', 'id' => 'id', 'role' => 'role', 'color' => 'color', 'depth' => 'depth', 'qids' => 'qids', 'label' => 'label', 'label_show' => 'labelShow', 'tooltip' => 'tooltip', 'views' => 'views', 'storey' => 'storey', 'points' => 'points', 'lift' => 'lift', 'directed' => 'directed', 'style' => 'style', 'arrows' => 'arrows', 'stations' => 'stations', 'marks' => 'marks', 'segment_roles' => 'segmentRoles']

$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 = ['type' => 'getType', 'id' => 'getId', 'role' => 'getRole', 'color' => 'getColor', 'depth' => 'getDepth', 'qids' => 'getQids', 'label' => 'getLabel', 'label_show' => 'getLabelShow', 'tooltip' => 'getTooltip', 'views' => 'getViews', 'storey' => 'getStorey', 'points' => 'getPoints', 'lift' => 'getLift', 'directed' => 'getDirected', 'style' => 'getStyle', 'arrows' => 'getArrows', 'stations' => 'getStations', 'marks' => 'getMarks', 'segment_roles' => 'getSegmentRoles']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['type' => null, 'id' => null, 'role' => null, 'color' => null, 'depth' => null, 'qids' => null, 'label' => null, 'label_show' => null, 'tooltip' => null, 'views' => null, 'storey' => null, 'points' => null, 'lift' => null, 'directed' => null, 'style' => null, 'arrows' => null, 'stations' => null, 'marks' => null, 'segment_roles' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'OverlayPathItem'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['type' => false, 'id' => false, 'role' => false, 'color' => false, 'depth' => false, 'qids' => false, 'label' => false, 'label_show' => false, 'tooltip' => false, 'views' => false, 'storey' => false, 'points' => false, 'lift' => false, 'directed' => false, 'style' => false, 'arrows' => false, 'stations' => false, 'marks' => false, 'segment_roles' => 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 = ['type' => 'string', 'id' => 'string', 'role' => 'string', 'color' => 'string', 'depth' => 'string', 'qids' => 'string[]', 'label' => 'string', 'label_show' => 'string', 'tooltip' => 'string', 'views' => 'string[]', 'storey' => 'string', 'points' => 'float[]', 'lift' => 'float', 'directed' => 'bool', 'style' => '\BIMworks\Model\OverlayPathItemAllOfStyle', 'arrows' => '\BIMworks\Model\OverlayPathItemAllOfArrows', 'stations' => '\BIMworks\Model\OverlayPathItemAllOfStations', 'marks' => '\BIMworks\Model\OverlayPathItemAllOfMarks[]', 'segment_roles' => 'mixed[][]']

$setters

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

protected static array<string|int, string> $setters = ['type' => 'setType', 'id' => 'setId', 'role' => 'setRole', 'color' => 'setColor', 'depth' => 'setDepth', 'qids' => 'setQids', 'label' => 'setLabel', 'label_show' => 'setLabelShow', 'tooltip' => 'setTooltip', 'views' => 'setViews', 'storey' => 'setStorey', 'points' => 'setPoints', 'lift' => 'setLift', 'directed' => 'setDirected', 'style' => 'setStyle', 'arrows' => 'setArrows', 'stations' => 'setStations', 'marks' => 'setMarks', 'segment_roles' => 'setSegmentRoles']

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

getColor()

Gets color

public getColor() : string|null
Return values
string|null

getDepth()

Gets depth

public getDepth() : string|null
Return values
string|null

getDepthAllowableValues()

Gets allowable values of the enum

public getDepthAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getDirected()

Gets directed

public getDirected() : bool|null
Return values
bool|null

getLabel()

Gets label

public getLabel() : string|null
Return values
string|null

getLabelShow()

Gets label_show

public getLabelShow() : string|null
Return values
string|null

getLabelShowAllowableValues()

Gets allowable values of the enum

public getLabelShowAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getLift()

Gets lift

public getLift() : float|null
Return values
float|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPoints()

Gets points

public getPoints() : array<string|int, float>
Return values
array<string|int, float>

getQids()

Gets qids

public getQids() : array<string|int, string>|null
Return values
array<string|int, string>|null

getRole()

Gets role

public getRole() : string|null
Return values
string|null

getRoleAllowableValues()

Gets allowable values of the enum

public getRoleAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getSegmentRoles()

Gets segment_roles

public getSegmentRoles() : array<string|int, array<string|int, mixed>>|null
Return values
array<string|int, array<string|int, mixed>>|null

getStorey()

Gets storey

public getStorey() : string|null
Return values
string|null

getters()

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

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

getTooltip()

Gets tooltip

public getTooltip() : string|null
Return values
string|null

getViews()

Gets views

public getViews() : array<string|int, string>|null
Return values
array<string|int, string>|null

getViewsAllowableValues()

Gets allowable values of the enum

public getViewsAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

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

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

Attributes
#[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>

setColor()

Sets color

public setColor(string|null $color) : self
Parameters
$color : string|null

Overrides the role colour.

Return values
self

setDepth()

Sets depth

public setDepth(string|null $depth) : self
Parameters
$depth : string|null

depth

Return values
self

setDirected()

Sets directed

public setDirected(bool|null $directed) : self
Parameters
$directed : bool|null

The path runs from its first point to its last.

Return values
self

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

Unique within the overlay.

Return values
self

setLabel()

Sets label

public setLabel(string|null $label) : self
Parameters
$label : string|null

label

Return values
self

setLabelShow()

Sets label_show

public setLabelShow(string|null $label_show) : self
Parameters
$label_show : string|null

When the label is on screen; hover shows it only while the item or one of its objects is under the cursor. Default always.

Return values
self

setLift()

Sets lift

public setLift(float|null $lift) : self
Parameters
$lift : float|null

Height of the drawing above the points in millimetres; default the tube radius + 10.

Return values
self

setPoints()

Sets points

public setPoints(array<string|int, float> $points) : self
Parameters
$points : array<string|int, float>

Flat x,y,z triples on the walking surface, millimetres, at most 20000 points.

Return values
self

setQids()

Sets qids

public setQids(array<string|int, string>|null $qids) : self
Parameters
$qids : array<string|int, string>|null

Related model objects.

Return values
self

setRole()

Sets role

public setRole(string|null $role) : self
Parameters
$role : string|null

Semantic role, mapped to the design-system palette by the viewer.

Return values
self

setSegmentRoles()

Sets segment_roles

public setSegmentRoles(array<string|int, array<string|int, mixed>>|null $segment_roles) : self
Parameters
$segment_roles : array<string|int, array<string|int, mixed>>|null

Runs [from, to, role] of segments between point indices drawn in another role.

Return values
self

setStorey()

Sets storey

public setStorey(string|null $storey) : self
Parameters
$storey : string|null

Storey qid hint for the 2D viewer.

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>

setTooltip()

Sets tooltip

public setTooltip(string|null $tooltip) : self
Parameters
$tooltip : string|null

tooltip

Return values
self

setType()

Sets type

public setType(string $type) : self
Parameters
$type : string

type

Return values
self

setViews()

Sets views

public setViews(array<string|int, string>|null $views) : self
Parameters
$views : array<string|int, string>|null

views

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>
On this page

Search results