Documentation

CompareResult
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareResult Class Doc Comment

Tags
category

Class

description

A compare result. Which fields are present depends on `status` and the detail level: while a compare runs only `result_uuid` and `status`

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
STATUS_FAILED  : mixed = 'FAILED'
STATUS_PENDING  : mixed = 'PENDING'
STATUS_READY  : mixed = 'READY'
STATUS_RUNNING  : mixed = 'RUNNING'

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
getAlignment()  : CompareAlignment|null
Gets alignment
getCached()  : bool|null
Gets cached
getClusters()  : array<string, CompareObjectSet>|null
Gets clusters
getCompletedOn()  : DateTime|null
Gets completed_on
getDefinition()  : CompareDefinitionRef|null
Gets definition
getEngineVersion()  : string|null
Gets engine_version
getError()  : string|null
Gets error
getFormat()  : string|null
Gets format
getHiddenFeatures()  : array<string|int, string>|null
Gets hidden_features
getLayers()  : array<string|int, CompareLayer>|null
Gets layers
getLeft()  : CompareResultSide|null
Gets left
getMatchers()  : array<string|int, string>|null
Gets matchers
getModelName()  : string
The original name of the model.
getMoves()  : CompareMoves|null
Gets moves
getObjects()  : array<string, CompareObjectSet>|null
Gets objects
getPaging()  : ComparePaging|null
Gets paging
getParameters()  : array<string, mixed>|null
Gets parameters
getRecords()  : array<string|int, CompareRecord>|null
Gets records
getResultUuid()  : string|null
Gets result_uuid
getRight()  : CompareResultSide|null
Gets right
getStats()  : CompareStats|null
Gets stats
getStatus()  : string|null
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSummary()  : CompareSummary|null
Gets summary
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTruncated()  : bool|null
Gets truncated
getVids()  : array<string|int, string>|null
Gets vids
getWarnings()  : array<string|int, CompareWarning>|null
Gets warnings
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
setAlignment()  : self
Sets alignment
setCached()  : self
Sets cached
setClusters()  : self
Sets clusters
setCompletedOn()  : self
Sets completed_on
setDefinition()  : self
Sets definition
setEngineVersion()  : self
Sets engine_version
setError()  : self
Sets error
setFormat()  : self
Sets format
setHiddenFeatures()  : self
Sets hidden_features
setLayers()  : self
Sets layers
setLeft()  : self
Sets left
setMatchers()  : self
Sets matchers
setMoves()  : self
Sets moves
setObjects()  : self
Sets objects
setPaging()  : self
Sets paging
setParameters()  : self
Sets parameters
setRecords()  : self
Sets records
setResultUuid()  : self
Sets result_uuid
setRight()  : self
Sets right
setStats()  : self
Sets stats
setStatus()  : self
Sets status
setSummary()  : self
Sets summary
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTruncated()  : self
Sets truncated
setVids()  : self
Sets vids
setWarnings()  : self
Sets warnings
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 = ['result_uuid' => 'result_uuid', 'status' => 'status', 'error' => 'error', 'cached' => 'cached', 'format' => 'format', 'engine_version' => 'engine_version', 'completed_on' => 'completed_on', 'left' => 'left', 'right' => 'right', 'vids' => 'vids', 'definition' => 'definition', 'parameters' => 'parameters', 'stats' => 'stats', 'warnings' => 'warnings', 'summary' => 'summary', 'objects' => 'objects', 'clusters' => 'clusters', 'alignment' => 'alignment', 'moves' => 'moves', 'matchers' => 'matchers', 'records' => 'records', 'paging' => 'paging', 'layers' => 'layers', 'hidden_features' => 'hiddenFeatures', 'truncated' => 'truncated']

$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 = ['result_uuid' => 'getResultUuid', 'status' => 'getStatus', 'error' => 'getError', 'cached' => 'getCached', 'format' => 'getFormat', 'engine_version' => 'getEngineVersion', 'completed_on' => 'getCompletedOn', 'left' => 'getLeft', 'right' => 'getRight', 'vids' => 'getVids', 'definition' => 'getDefinition', 'parameters' => 'getParameters', 'stats' => 'getStats', 'warnings' => 'getWarnings', 'summary' => 'getSummary', 'objects' => 'getObjects', 'clusters' => 'getClusters', 'alignment' => 'getAlignment', 'moves' => 'getMoves', 'matchers' => 'getMatchers', 'records' => 'getRecords', 'paging' => 'getPaging', 'layers' => 'getLayers', 'hidden_features' => 'getHiddenFeatures', 'truncated' => 'getTruncated']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['result_uuid' => 'uuid', 'status' => null, 'error' => null, 'cached' => null, 'format' => null, 'engine_version' => null, 'completed_on' => 'date-time', 'left' => null, 'right' => null, 'vids' => 'uuid', 'definition' => null, 'parameters' => null, 'stats' => null, 'warnings' => null, 'summary' => null, 'objects' => null, 'clusters' => null, 'alignment' => null, 'moves' => null, 'matchers' => null, 'records' => null, 'paging' => null, 'layers' => null, 'hidden_features' => null, 'truncated' => 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 = 'CompareResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['result_uuid' => false, 'status' => false, 'error' => false, 'cached' => false, 'format' => false, 'engine_version' => false, 'completed_on' => false, 'left' => false, 'right' => false, 'vids' => false, 'definition' => false, 'parameters' => false, 'stats' => false, 'warnings' => false, 'summary' => false, 'objects' => false, 'clusters' => false, 'alignment' => false, 'moves' => false, 'matchers' => false, 'records' => false, 'paging' => false, 'layers' => false, 'hidden_features' => false, 'truncated' => 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 = ['result_uuid' => 'string', 'status' => 'string', 'error' => 'string', 'cached' => 'bool', 'format' => 'string', 'engine_version' => 'string', 'completed_on' => '\DateTime', 'left' => '\BIMworks\Model\CompareResultSide', 'right' => '\BIMworks\Model\CompareResultSide', 'vids' => 'string[]', 'definition' => '\BIMworks\Model\CompareDefinitionRef', 'parameters' => 'array<string,mixed>', 'stats' => '\BIMworks\Model\CompareStats', 'warnings' => '\BIMworks\Model\CompareWarning[]', 'summary' => '\BIMworks\Model\CompareSummary', 'objects' => 'array<string,\BIMworks\Model\CompareObjectSet>', 'clusters' => 'array<string,\BIMworks\Model\CompareObjectSet>', 'alignment' => '\BIMworks\Model\CompareAlignment', 'moves' => '\BIMworks\Model\CompareMoves', 'matchers' => 'string[]', 'records' => '\BIMworks\Model\CompareRecord[]', 'paging' => '\BIMworks\Model\ComparePaging', 'layers' => '\BIMworks\Model\CompareLayer[]', 'hidden_features' => 'string[]', 'truncated' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['result_uuid' => 'setResultUuid', 'status' => 'setStatus', 'error' => 'setError', 'cached' => 'setCached', 'format' => 'setFormat', 'engine_version' => 'setEngineVersion', 'completed_on' => 'setCompletedOn', 'left' => 'setLeft', 'right' => 'setRight', 'vids' => 'setVids', 'definition' => 'setDefinition', 'parameters' => 'setParameters', 'stats' => 'setStats', 'warnings' => 'setWarnings', 'summary' => 'setSummary', 'objects' => 'setObjects', 'clusters' => 'setClusters', 'alignment' => 'setAlignment', 'moves' => 'setMoves', 'matchers' => 'setMatchers', 'records' => 'setRecords', 'paging' => 'setPaging', 'layers' => 'setLayers', 'hidden_features' => 'setHiddenFeatures', 'truncated' => 'setTruncated']

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>

getCached()

Gets cached

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

getCompletedOn()

Gets completed_on

public getCompletedOn() : DateTime|null
Return values
DateTime|null

getEngineVersion()

Gets engine_version

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

getError()

Gets error

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

getFormat()

Gets format

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

getHiddenFeatures()

Gets hidden_features

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

getMatchers()

Gets matchers

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getParameters()

Gets parameters

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

getResultUuid()

Gets result_uuid

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

getStatus()

Gets status

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

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, 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>

getTruncated()

Gets truncated

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

getVids()

Gets vids

public getVids() : array<string|int, string>|null
Return values
array<string|int, 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>

setCached()

Sets cached

public setCached(bool|null $cached) : self
Parameters
$cached : bool|null

CompareModels only. Whether the result was answered from the store

Return values
self

setClusters()

Sets clusters

public setClusters(array<string, CompareObjectSet>|null $clusters) : self
Parameters
$clusters : array<string, CompareObjectSet>|null

Details objects and up. Per cluster id (see summary.clusters), the object ids of each side, aligned

Return values
self

setCompletedOn()

Sets completed_on

public setCompletedOn(DateTime|null $completed_on) : self
Parameters
$completed_on : DateTime|null

completed_on

Return values
self

setEngineVersion()

Sets engine_version

public setEngineVersion(string|null $engine_version) : self
Parameters
$engine_version : string|null

The version of the compare algorithm the result was computed with

Return values
self

setError()

Sets error

public setError(string|null $error) : self
Parameters
$error : string|null

Why the compare failed (status FAILED)

Return values
self

setFormat()

Sets format

public setFormat(string|null $format) : self
Parameters
$format : string|null

The format of the result document, bcol-result/1

Return values
self

setHiddenFeatures()

Sets hidden_features

public setHiddenFeatures(array<string|int, string>|null $hidden_features) : self
Parameters
$hidden_features : array<string|int, string>|null

Features the definition reads that the caller's feature visibility hides; they were left out

Return values
self

setLayers()

Sets layers

public setLayers(array<string|int, CompareLayer>|null $layers) : self
Parameters
$layers : array<string|int, CompareLayer>|null

Details full. The styling of every category and side

Return values
self

setMatchers()

Sets matchers

public setMatchers(array<string|int, string>|null $matchers) : self
Parameters
$matchers : array<string|int, string>|null

The matchers in order, lineage first when the Versions descend from one another; the object sets' matched_by index this list

Return values
self

setObjects()

Sets objects

public setObjects(array<string, CompareObjectSet>|null $objects) : self
Parameters
$objects : array<string, CompareObjectSet>|null

Details objects and up. Per category id, the object ids of each side: for pairs the two arrays are aligned, added objects have right ids only, removed objects left ids only

Return values
self

setParameters()

Sets parameters

public setParameters(array<string, mixed>|null $parameters) : self
Parameters
$parameters : array<string, mixed>|null

What else the result was computed with besides the definition (the side conditions, the limits, a fingerprint of the caller's feature visibility)

Return values
self

setRecords()

Sets records

public setRecords(array<string|int, CompareRecord>|null $records) : self
Parameters
$records : array<string|int, CompareRecord>|null

Details changes and up. One page of the records of the added, removed and changed objects, in legend order

Return values
self

setResultUuid()

Sets result_uuid

public setResultUuid(string|null $result_uuid) : self
Parameters
$result_uuid : string|null

The stored result, for GetCompareResult

Return values
self

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

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>

setTruncated()

Sets truncated

public setTruncated(bool|null $truncated) : self
Parameters
$truncated : bool|null

Whether records were left out because there are more than the server keeps

Return values
self

setVids()

Sets vids

public setVids(array<string|int, string>|null $vids) : self
Parameters
$vids : array<string|int, string>|null

The left and the right Version. With a federation every model of both sides, the left side's models first; the _v indexes of objects, records, layers and moves point into this list

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