Documentation

CompareAlignment
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareAlignment Class Doc Comment

Tags
category

Class

description

The rigid move most matched objects with geometry share, when at least half of them do

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

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
getApplied()  : bool|null
Gets applied
getCount()  : int|null
Gets count
getMatrix()  : array<string|int, float>|null
Gets matrix
getMeasured()  : int|null
Gets measured
getModelName()  : string
The original name of the model.
getRotation()  : CompareAlignmentRotation|null
Gets rotation
getShare()  : float|null
Gets share
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTranslation()  : array<string|int, float>|null
Gets translation
getUnit()  : string|null
Gets unit
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
setApplied()  : self
Sets applied
setCount()  : self
Sets count
setMatrix()  : self
Sets matrix
setMeasured()  : self
Sets measured
setRotation()  : self
Sets rotation
setShare()  : self
Sets share
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTranslation()  : self
Sets translation
setUnit()  : self
Sets unit
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 = ['applied' => 'applied', 'translation' => 'translation', 'unit' => 'unit', 'rotation' => 'rotation', 'matrix' => 'matrix', 'count' => 'count', 'measured' => 'measured', 'share' => 'share']

$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 = ['applied' => 'getApplied', 'translation' => 'getTranslation', 'unit' => 'getUnit', 'rotation' => 'getRotation', 'matrix' => 'getMatrix', 'count' => 'getCount', 'measured' => 'getMeasured', 'share' => 'getShare']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['applied' => null, 'translation' => null, 'unit' => null, 'rotation' => null, 'matrix' => null, 'count' => null, 'measured' => null, 'share' => 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 = 'CompareAlignment'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['applied' => false, 'translation' => false, 'unit' => false, 'rotation' => false, 'matrix' => false, 'count' => false, 'measured' => false, 'share' => 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 = ['applied' => 'bool', 'translation' => 'float[]', 'unit' => 'string', 'rotation' => '\BIMworks\Model\CompareAlignmentRotation', 'matrix' => 'float[]', 'count' => 'int', 'measured' => 'int', 'share' => 'float']

$setters

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

protected static array<string|int, string> $setters = ['applied' => 'setApplied', 'translation' => 'setTranslation', 'unit' => 'setUnit', 'rotation' => 'setRotation', 'matrix' => 'setMatrix', 'count' => 'setCount', 'measured' => 'setMeasured', 'share' => 'setShare']

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>

getApplied()

Gets applied

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

getCount()

Gets count

public getCount() : int|null
Return values
int|null

getMatrix()

Gets matrix

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

getMeasured()

Gets measured

public getMeasured() : int|null
Return values
int|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getShare()

Gets share

public getShare() : float|null
Return values
float|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>

getTranslation()

Gets translation

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

getUnit()

Gets unit

public getUnit() : string|null
Return values
string|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

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>

setApplied()

Sets applied

public setApplied(bool|null $applied) : self
Parameters
$applied : bool|null

Whether the right side was judged with the move undone (align auto)

Return values
self

setCount()

Sets count

public setCount(int|null $count) : self
Parameters
$count : int|null

The pairs that share it

Return values
self

setMatrix()

Sets matrix

public setMatrix(array<string|int, float>|null $matrix) : self
Parameters
$matrix : array<string|int, float>|null

The move as a column-major 4x4 matrix in mm

Return values
self

setMeasured()

Sets measured

public setMeasured(int|null $measured) : self
Parameters
$measured : int|null

The pairs with geometry it was found among

Return values
self

setShare()

Sets share

public setShare(float|null $share) : self
Parameters
$share : float|null

share

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>

setTranslation()

Sets translation

public setTranslation(array<string|int, float>|null $translation) : self
Parameters
$translation : array<string|int, float>|null

x, y, z

Return values
self

setUnit()

Sets unit

public setUnit(string|null $unit) : self
Parameters
$unit : string|null

mm

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