Documentation

ObjectCheckResult
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ObjectCheckResult 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

DISCRIMINATOR  = null
TYPE_OBJECT_CHECK_RESULT  = 'ObjectCheckResult'

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
getCamera()  : Camera
Gets camera
getCenterMm()  : Vector3
Gets center_mm
getCheckResult()  : CheckResultStatus
Gets check_result
getHasGeometry()  : bool
Gets has_geometry
getId()  : int
Gets id
getIsolate()  : bool
Gets isolate
getModelInfo()  : ModelInfo
Gets model_info
getModelName()  : string
The original name of the model.
getMultiplierToMm()  : float
Gets multiplier_to_mm
getObjectInfos()  : array<string|int, ObjectInfo>
Gets object_infos
getResolvedActions()  : ResolvedActions
Gets resolved_actions
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string
Gets type
getTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getUuid()  : string
Gets uuid
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
setCamera()  : self
Sets camera
setCenterMm()  : self
Sets center_mm
setCheckResult()  : self
Sets check_result
setHasGeometry()  : self
Sets has_geometry
setId()  : self
Sets id
setIsolate()  : self
Sets isolate
setModelInfo()  : self
Sets model_info
setMultiplierToMm()  : self
Sets multiplier_to_mm
setObjectInfos()  : self
Sets object_infos
setResolvedActions()  : self
Sets resolved_actions
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : self
Sets type
setUuid()  : self
Sets uuid
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

TYPE_OBJECT_CHECK_RESULT

public mixed TYPE_OBJECT_CHECK_RESULT = 'ObjectCheckResult'

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', 'uuid' => 'uuid', 'check_result' => 'checkResult', 'resolved_actions' => 'resolvedActions', 'object_infos' => 'objectInfos', 'model_info' => 'modelInfo', 'camera' => 'camera', 'multiplier_to_mm' => 'multiplierToMm', 'center_mm' => 'centerMm', 'isolate' => 'isolate', 'has_geometry' => 'hasGeometry']

$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', 'uuid' => 'getUuid', 'check_result' => 'getCheckResult', 'resolved_actions' => 'getResolvedActions', 'object_infos' => 'getObjectInfos', 'model_info' => 'getModelInfo', 'camera' => 'getCamera', 'multiplier_to_mm' => 'getMultiplierToMm', 'center_mm' => 'getCenterMm', 'isolate' => 'getIsolate', 'has_geometry' => 'getHasGeometry']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['type' => null, 'id' => null, 'uuid' => 'uuid', 'check_result' => null, 'resolved_actions' => null, 'object_infos' => null, 'model_info' => null, 'camera' => null, 'multiplier_to_mm' => null, 'center_mm' => null, 'isolate' => null, 'has_geometry' => 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 = 'ObjectCheckResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['type' => false, 'id' => false, 'uuid' => false, 'check_result' => false, 'resolved_actions' => false, 'object_infos' => false, 'model_info' => false, 'camera' => false, 'multiplier_to_mm' => false, 'center_mm' => false, 'isolate' => false, 'has_geometry' => 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' => 'int', 'uuid' => 'string', 'check_result' => '\BIMworks\Model\CheckResultStatus', 'resolved_actions' => '\BIMworks\Model\ResolvedActions', 'object_infos' => '\BIMworks\Model\ObjectInfo[]', 'model_info' => '\BIMworks\Model\ModelInfo', 'camera' => '\BIMworks\Model\Camera', 'multiplier_to_mm' => 'float', 'center_mm' => '\BIMworks\Model\Vector3', 'isolate' => 'bool', 'has_geometry' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['type' => 'setType', 'id' => 'setId', 'uuid' => 'setUuid', 'check_result' => 'setCheckResult', 'resolved_actions' => 'setResolvedActions', 'object_infos' => 'setObjectInfos', 'model_info' => 'setModelInfo', 'camera' => 'setCamera', 'multiplier_to_mm' => 'setMultiplierToMm', 'center_mm' => 'setCenterMm', 'isolate' => 'setIsolate', 'has_geometry' => 'setHasGeometry']

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>

getHasGeometry()

Gets has_geometry

public getHasGeometry() : bool
Return values
bool

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getMultiplierToMm()

Gets multiplier_to_mm

public getMultiplierToMm() : float
Return values
float

getters()

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

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

getTypeAllowableValues()

Gets allowable values of the enum

public getTypeAllowableValues() : 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>

setHasGeometry()

Sets has_geometry

public setHasGeometry(bool $has_geometry) : self
Parameters
$has_geometry : bool

has_geometry

Return values
self

setId()

Sets id

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

id

Return values
self

setIsolate()

Sets isolate

public setIsolate(bool $isolate) : self
Parameters
$isolate : bool

isolate

Return values
self

setMultiplierToMm()

Sets multiplier_to_mm

public setMultiplierToMm(float $multiplier_to_mm) : self
Parameters
$multiplier_to_mm : float

Unit multiplier to millimeters.

Return values
self

setObjectInfos()

Sets object_infos

public setObjectInfos(array<string|int, ObjectInfo> $object_infos) : self
Parameters
$object_infos : array<string|int, ObjectInfo>

object_infos

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>

setType()

Sets type

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

type

Return values
self

setUuid()

Sets uuid

public setUuid(string $uuid) : self
Parameters
$uuid : string

uuid

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