blob: 6c7ab99771f628b8a3ba15415115322734ec4e8e [file] [log] [blame]
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>LightweightM2M_Types - Massive IoT Test Tools</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.52 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="LightweightM2M_Types"></a>LightweightM2M_Types</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains type definitions for LWM2M PDUs</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#LightweightM2M_Types" >LightweightM2M_Types</a></td><td class=SDescription>This module contains type definitions for LWM2M PDUs</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#ObjectPath" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">ObjectPath</a></td><td class=SDescription>Models an access path up to a resource</td></tr><tr class="SType"><td class=SEntry><a href="#ObjectPath_List" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">ObjectPath_List</a></td><td class=SDescription>List of <a href="#ObjectPath" class=LType id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">ObjectPath</a></td></tr><tr class="SType SMarked"><td class=SEntry><a href="#LwM2M_Resource" id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">LwM2M_Resource</a></td><td class=SDescription>Models a smart resource</td></tr><tr class="SType"><td class=SEntry><a href="#LwM2M_ResourceValue" id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">LwM2M_ResourceValue</a></td><td class=SDescription>Union for storing the value of a smart resource</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#LwM2M_ResourceValue_List" id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">LwM2M_ResourceValue_List</a></td><td class=SDescription>List of <a href="#LwM2M_ResourceValue" class=LType id=link7 onMouseOver="ShowTip(event, 'tt4', 'link7')" onMouseOut="HideTip('tt4')">LwM2M_ResourceValue</a></td></tr><tr class="SType"><td class=SEntry><a href="#LwM2M_Resource_List" id=link8 onMouseOver="ShowTip(event, 'tt6', 'link8')" onMouseOut="HideTip('tt6')">LwM2M_Resource_List</a></td><td class=SDescription>List of <a href="#LwM2M_Resource" class=LType id=link9 onMouseOver="ShowTip(event, 'tt3', 'link9')" onMouseOut="HideTip('tt3')">LwM2M_Resource</a></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="ObjectPath"></a>ObjectPath</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record ObjectPath</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Models an access path up to a resource</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>objectId</td><td class=CDLDescription><b>integer</b> - object id</td></tr><tr><td class=CDLEntry>objectInstanceId</td><td class=CDLDescription><b>integer</b> - object instance id (optional)</td></tr><tr><td class=CDLEntry>resourceId</td><td class=CDLDescription><b>integer</b> - resource id (optional)</td></tr></table></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="ObjectPath_List"></a>ObjectPath_List</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record of ObjectPath ObjectPath_List</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>List of <a href="#ObjectPath" class=LType id=link10 onMouseOver="ShowTip(event, 'tt1', 'link10')" onMouseOut="HideTip('tt1')">ObjectPath</a></p></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LwM2M_Resource"></a>LwM2M_Resource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record LwM2M_Resource</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Models a smart resource</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>id</td><td class=CDLDescription><b>integer</b> - unique id of the smart resource</td></tr><tr><td class=CDLEntry>objId</td><td class=CDLDescription><b>integer</b> - object id</td></tr><tr><td class=CDLEntry>objInstId</td><td class=CDLDescription><b>integer</b> - object instance id</td></tr><tr><td class=CDLEntry>observed</td><td class=CDLDescription><b>boolean</b> - flag, true when observed</td></tr><tr><td class=CDLEntry>dataSample</td><td class=CDLDescription>&lt;LwM2M_DataSample_Information&gt; - pointers to data sample values (optional)</td></tr><tr><td class=CDLEntry>val</td><td class=CDLDescription><a href="#LwM2M_ResourceValue" class=LType id=link11 onMouseOver="ShowTip(event, 'tt4', 'link11')" onMouseOut="HideTip('tt4')">LwM2M_ResourceValue</a> - value of the resource</td></tr></table><h4 class=CHeading>Related Functions</h4><ul><li><a href="EPTF_LwM2M_Object_Functions-ttcn.html#f_LwM2M_resourceHash_forResource" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt7', 'link12')" onMouseOut="HideTip('tt7')">f_LwM2M_resourceHash_forResource</a> (<b>in</b> <a href="#LwM2M_Resource" class=LType id=link13 onMouseOver="ShowTip(event, 'tt3', 'link13')" onMouseOut="HideTip('tt3')">LwM2M_Resource</a> p_res)</li><li><a href="EPTF_LwM2M_Object_Functions-ttcn.html#f_LwM2M_Resource_setNextDataSample" class=LFunction id=link14 onMouseOver="ShowTip(event, 'tt8', 'link14')" onMouseOut="HideTip('tt8')">f_LwM2M_Resource_setNextDataSample</a> (<b>inout</b> <a href="#LwM2M_Resource" class=LType id=link15 onMouseOver="ShowTip(event, 'tt3', 'link15')" onMouseOut="HideTip('tt3')">LwM2M_Resource</a> p_res, <b>inout</b> <a href="EPTF_LwM2M_Object_Definitions-ttcn.html#LwM2M_DataSamples_DB" class=LType id=link16 onMouseOver="ShowTip(event, 'tt9', 'link16')" onMouseOut="HideTip('tt9')">LwM2M_DataSamples_DB</a> p_db)</li></ul></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LwM2M_ResourceValue"></a>LwM2M_ResourceValue</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union LwM2M_ResourceValue</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Union for storing the value of a smart resource</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>intValue</td><td class=CDLDescription><b>integer</b></td></tr><tr><td class=CDLEntry>strValue</td><td class=CDLDescription><b>charstring</b></td></tr><tr><td class=CDLEntry>floatValue</td><td class=CDLDescription><b>float</b></td></tr><tr><td class=CDLEntry>opaqueValue</td><td class=CDLDescription><b>octetstring</b></td></tr><tr><td class=CDLEntry>boolValue</td><td class=CDLDescription><b>boolean</b></td></tr></table></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LwM2M_ResourceValue_List"></a>LwM2M_ResourceValue_List</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record of LwM2M_ResourceValue LwM2M_ResourceValue_List</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>List of <a href="#LwM2M_ResourceValue" class=LType id=link17 onMouseOver="ShowTip(event, 'tt4', 'link17')" onMouseOut="HideTip('tt4')">LwM2M_ResourceValue</a></p></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LwM2M_Resource_List"></a>LwM2M_Resource_List</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record of LwM2M_Resource LwM2M_Resource_List</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>List of <a href="#LwM2M_Resource" class=LType id=link18 onMouseOver="ShowTip(event, 'tt3', 'link18')" onMouseOut="HideTip('tt3')">LwM2M_Resource</a></p></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record ObjectPath</td></tr></table></blockquote>Models an access path up to a resource</div></div><div class=CToolTip id="tt2"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record of ObjectPath ObjectPath_List</td></tr></table></blockquote>List of ObjectPath</div></div><div class=CToolTip id="tt3"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record LwM2M_Resource</td></tr></table></blockquote>Models a smart resource</div></div><div class=CToolTip id="tt4"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union LwM2M_ResourceValue</td></tr></table></blockquote>Union for storing the value of a smart resource</div></div><div class=CToolTip id="tt5"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record of LwM2M_ResourceValue LwM2M_ResourceValue_List</td></tr></table></blockquote>List of LwM2M_ResourceValue</div></div><div class=CToolTip id="tt6"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record of LwM2M_Resource LwM2M_Resource_List</td></tr></table></blockquote>List of LwM2M_Resource</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_LwM2M_resourceHash_forResource(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>LwM2M_Resource&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>p_res</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote>Function to generate a unique key for the LwM2M_Resource instance</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_LwM2M_Resource_setNextDataSample(</td><td class="PTypePrefix prettyprint " nowrap>inout&nbsp;</td><td class="PType prettyprint " nowrap>LwM2M_Resource&nbsp;</td><td class="PParameter prettyprint " nowrap>p_res,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>inout&nbsp;</td><td class="PType prettyprint " nowrap>LwM2M_DataSamples_DB&nbsp;</td><td class="PParameter prettyprint " nowrap>p_db</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>In case the LwM2M_Resource instance is associated with a LwM2M_DataSamples it will set its value to the next from the samples</div></div><div class=CToolTip id="tt9"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record LwM2M_DataSamples_DB</td></tr></table></blockquote>Storing LwM2M_DataSamples instances</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>