\MiotApi\Contract\InstanceProperty

属性描述需要表达这几个意思: 语义是什么? 数据格式是什么? 是否可读?是否可写?数据变化了是否有通知? 值是否有约束?如果有,取值范围是离散值还是连续值? 单位是否定义?如果有定义,单位是什么?

Class PropertySpecification

Summary

Methods
Properties
Constants
init()
getFormat()
getAccess()
getValueRange()
getValueList()
getUnit()
__construct()
getUrn()
getType()
getDescription()
toContext()
toCollection()
toJson()
toArray()
__get()
__call()
getIid()
verify()
canRead()
canWrite()
canNotify()
getSpecification()
getSpecificationContext()
No public properties found
No constants found
No protected methods found
$format
$formatMap
$access
$accessMap
$valueRange
$valueList
$unit
$unitMap
$collection
$urn
$description
$data
$iid
$specification
N/A
No private methods found
No private properties found
N/A

Properties

$format

$format : 

数据格式.

数据格式 描述 bool 布尔值: true/false 或 1/0 uint8 无符号8位整型 uint16 无符号16位整型 uint32 无符号32位整型 int8 有符号8位整型 int16 有符号16位整型 int32 有符号32位整型 int64 有符号64位整型 float 浮点数 string 字符串

Type

$formatMap

$formatMap : 

Type

$access

$access : 

访问方式 值 描述 read 读 write 写 notify 通知.

Type

$accessMap

$accessMap : 

Type

$valueRange

$valueRange : 

对取值范围进行约束,可选字段 当format为整型或浮点数,可定义value-range,比如: 最小值 最大值 步长 16 32 0.5.

Type

$valueList

$valueList : 

对取值范围进行约束,可选字段 当format为整型,可定义"value-list",每个元素都包含:value description.

Type

$unit

$unit : 

单位,可选字段 当format为整型或浮点型,可定义unit值

值 描述 percentage 百分比 celsius 摄氏度 senconds 秒 minutes 分 hours 小时 days 天 kelvin 开氏温标 pascal 帕斯卡(大气压强单位) arcdegrees 弧度(角度单位)

Type

$unitMap

$unitMap : 

Type

$collection

$collection : 

Type

$urn

$urn : 

Type

$description

$description : 

描述: 纯文本字段.

Type

$data

$data : 

Type

$iid

$iid : 

实例ID(Instance ID,简称iid).

Type

$specification

$specification : 

type对象

Type

Methods

init()

init() 

getFormat()

getFormat() : mixed

Returns

mixed

getAccess()

getAccess() : mixed

Returns

mixed

getValueRange()

getValueRange() : mixed

Returns

mixed

getValueList()

getValueList() : mixed

Returns

mixed

getUnit()

getUnit() : mixed

Returns

mixed

__construct()

__construct(  $data = array()) 

Parameters

$data

getUrn()

getUrn() 

getType()

getType() 

getDescription()

getDescription() 

toContext()

toContext() 

toCollection()

toCollection() 

toJson()

toJson() 

toArray()

toArray() 

__get()

__get(  $key) 

Parameters

$key

__call()

__call(string  $method, array  $parameters) : mixed

Proxy a method call onto the collection items.

Parameters

string $method
array $parameters

Returns

mixed

getIid()

getIid() 

verify()

verify(  $value) : boolean

验证给定的值是否 符合 format.

Parameters

$value

Returns

boolean

canRead()

canRead() 

canWrite()

canWrite() 

canNotify()

canNotify() 

getSpecification()

getSpecification() 

getSpecificationContext()

getSpecificationContext()