Documentation

LinkedDataAnchor
in package
implements ModelInterface, ArrayAccess, JsonSerializable

LinkedDataAnchor Class Doc Comment

Tags
description

Where a link was on a span of Versions, first_version to last_version (open when absent)

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, 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, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string, string|null>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string, 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, string>
Array of attributes where the key is the local name, and the value is the original name
getCandidates()  : array<string|int, int>|null
Gets candidates
getConfidence()  : float|null
Gets confidence
getConfirmedBy()  : string|null
Gets confirmed_by
getConfirmedOn()  : string|null
Gets confirmed_on
getDirection()  : LinkedDataAnchorDirection|null
Gets direction
getFirstVersion()  : int|null
Gets first_version
getFirstVersionUuid()  : string|null
Gets first_version_uuid
getFollowedOn()  : string|null
Gets followed_on
getHow()  : LinkedDataAnchorHow|null
Gets how
getLastVersion()  : int|null
Gets last_version
getLastVersionUuid()  : string|null
Gets last_version_uuid
getLinkUuid()  : string|null
Gets link_uuid
getModelName()  : string
The original name of the model.
getOid()  : int|null
Gets oid
getState()  : LinkedDataAnchorState|null
Gets state
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getUuid()  : string|null
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, string>
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, string|null>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string, string>
Array of property to type mappings. Used for (de)serialization
setCandidates()  : $this
Sets candidates
setConfidence()  : $this
Sets confidence
setConfirmedBy()  : $this
Sets confirmed_by
setConfirmedOn()  : $this
Sets confirmed_on
setDirection()  : $this
Sets direction
setFirstVersion()  : $this
Sets first_version
setFirstVersionUuid()  : $this
Sets first_version_uuid
setFollowedOn()  : $this
Sets followed_on
setHow()  : $this
Sets how
setLastVersion()  : $this
Sets last_version
setLastVersionUuid()  : $this
Sets last_version_uuid
setLinkUuid()  : $this
Sets link_uuid
setOid()  : $this
Sets oid
setState()  : $this
Sets state
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setUuid()  : $this
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, bool>
Array of nullable properties
fillIfExists()  : 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
getOpenAPINullablesSetToNull()  : array<string, bool>
Array of nullable field names deliberately set to null
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, string> $attributeMap = ['uuid' => 'uuid', 'link_uuid' => 'link_uuid', 'direction' => 'direction', 'first_version' => 'first_version', 'first_version_uuid' => 'first_version_uuid', 'last_version' => 'last_version', 'last_version_uuid' => 'last_version_uuid', 'oid' => 'oid', 'how' => 'how', 'state' => 'state', 'confidence' => 'confidence', 'candidates' => 'candidates', 'followed_on' => 'followed_on', 'confirmed_on' => 'confirmed_on', 'confirmed_by' => 'confirmed_by']

$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, string> $getters = ['uuid' => 'getUuid', 'link_uuid' => 'getLinkUuid', 'direction' => 'getDirection', 'first_version' => 'getFirstVersion', 'first_version_uuid' => 'getFirstVersionUuid', 'last_version' => 'getLastVersion', 'last_version_uuid' => 'getLastVersionUuid', 'oid' => 'getOid', 'how' => 'getHow', 'state' => 'getState', 'confidence' => 'getConfidence', 'candidates' => 'getCandidates', 'followed_on' => 'getFollowedOn', 'confirmed_on' => 'getConfirmedOn', 'confirmed_by' => 'getConfirmedBy']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['uuid' => 'uuid', 'link_uuid' => 'uuid', 'direction' => null, 'first_version' => null, 'first_version_uuid' => 'uuid', 'last_version' => null, 'last_version_uuid' => 'uuid', 'oid' => null, 'how' => null, 'state' => null, 'confidence' => 'double', 'candidates' => null, 'followed_on' => null, 'confirmed_on' => null, 'confirmed_by' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'LinkedDataAnchor'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['uuid' => false, 'link_uuid' => false, 'direction' => false, 'first_version' => false, 'first_version_uuid' => false, 'last_version' => false, 'last_version_uuid' => false, 'oid' => false, 'how' => false, 'state' => false, 'confidence' => false, 'candidates' => false, 'followed_on' => false, 'confirmed_on' => false, 'confirmed_by' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string, bool> $openAPINullablesSetToNull = []

$openAPITypes

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

protected static array<string, string> $openAPITypes = ['uuid' => 'string', 'link_uuid' => 'string', 'direction' => '\BIMworks\Model\LinkedDataAnchorDirection', 'first_version' => 'int', 'first_version_uuid' => 'string', 'last_version' => 'int', 'last_version_uuid' => 'string', 'oid' => 'int', 'how' => '\BIMworks\Model\LinkedDataAnchorHow', 'state' => '\BIMworks\Model\LinkedDataAnchorState', 'confidence' => 'float', 'candidates' => 'int[]', 'followed_on' => 'string', 'confirmed_on' => 'string', 'confirmed_by' => 'string']

$setters

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

protected static array<string, string> $setters = ['uuid' => 'setUuid', 'link_uuid' => 'setLinkUuid', 'direction' => 'setDirection', 'first_version' => 'setFirstVersion', 'first_version_uuid' => 'setFirstVersionUuid', 'last_version' => 'setLastVersion', 'last_version_uuid' => 'setLastVersionUuid', 'oid' => 'setOid', 'how' => 'setHow', 'state' => 'setState', 'confidence' => 'setConfidence', 'candidates' => 'setCandidates', 'followed_on' => 'setFollowedOn', 'confirmed_on' => 'setConfirmedOn', 'confirmed_by' => 'setConfirmedBy']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = 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, string>
Return values
array<string, string>

getCandidates()

Gets candidates

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

getConfidence()

Gets confidence

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

getConfirmedBy()

Gets confirmed_by

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

getConfirmedOn()

Gets confirmed_on

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

getFirstVersion()

Gets first_version

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

getFirstVersionUuid()

Gets first_version_uuid

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

getFollowedOn()

Gets followed_on

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

getLastVersion()

Gets last_version

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

getLastVersionUuid()

Gets last_version_uuid

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

getLinkUuid()

Gets link_uuid

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getters()

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

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

getUuid()

Gets uuid

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

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|string|null $offset, mixed $value) : void
Parameters
$offset : int|string|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, string|null>
Return values
array<string, string|null>

openAPITypes()

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

public static openAPITypes() : array<string, string>
Return values
array<string, string>

setCandidates()

Sets candidates

public setCandidates(array<string|int, int>|null $candidates) : $this
Parameters
$candidates : array<string|int, int>|null

The objects of a CHECK span with the same GlobalId

Return values
$this

setConfidence()

Sets confidence

public setConfidence(float|null $confidence) : $this
Parameters
$confidence : float|null

Of a MATCHED span, 0 to 1

Return values
$this

setConfirmedBy()

Sets confirmed_by

public setConfirmedBy(string|null $confirmed_by) : $this
Parameters
$confirmed_by : string|null

confirmed_by

Return values
$this

setConfirmedOn()

Sets confirmed_on

public setConfirmedOn(string|null $confirmed_on) : $this
Parameters
$confirmed_on : string|null

confirmed_on

Return values
$this

setFirstVersion()

Sets first_version

public setFirstVersion(int|null $first_version) : $this
Parameters
$first_version : int|null

first_version

Return values
$this

setFirstVersionUuid()

Sets first_version_uuid

public setFirstVersionUuid(string|null $first_version_uuid) : $this
Parameters
$first_version_uuid : string|null

first_version_uuid

Return values
$this

setFollowedOn()

Sets followed_on

public setFollowedOn(string|null $followed_on) : $this
Parameters
$followed_on : string|null

followed_on

Return values
$this

setLastVersion()

Sets last_version

public setLastVersion(int|null $last_version) : $this
Parameters
$last_version : int|null

last_version

Return values
$this

setLastVersionUuid()

Sets last_version_uuid

public setLastVersionUuid(string|null $last_version_uuid) : $this
Parameters
$last_version_uuid : string|null

last_version_uuid

Return values
$this

setLinkUuid()

Sets link_uuid

public setLinkUuid(string|null $link_uuid) : $this
Parameters
$link_uuid : string|null

link_uuid

Return values
$this

setOid()

Sets oid

public setOid(int|null $oid) : $this
Parameters
$oid : int|null

The object on these Versions; absent when orphaned

Return values
$this

setters()

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

public static setters() : array<string, string>
Return values
array<string, string>

setUuid()

Sets uuid

public setUuid(string|null $uuid) : $this
Parameters
$uuid : string|null

uuid

Return values
$this

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, bool>
Return values
array<string, bool>

fillIfExists()

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 fillIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string, bool>
Return values
array<string, bool>

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string, bool>
On this page

Search results