Commit 0da5d59f authored by Miguel Angel Reina Ortega's avatar Miguel Angel Reina Ortega
Browse files

Code documentation (EOL Windows format)

parent de314ae7
......@@ -7,7 +7,7 @@
*
* @author ETSI
* @version $URL: https://forge.etsi.org/svn/oneM2M/trunk/ttcn/OneM2M_Functions.ttcn $
* $Id: OneM2M_Functions.ttcn 99 2016-06-09 15:04:43Z reinaortega $
* $Id: OneM2M_Functions.ttcn 101 2016-07-08 15:41:06Z reinaortega $
* @desc Module containing functions for oneM2M
*
*/
......@@ -46,11 +46,11 @@ module OneM2M_Functions {
group preambleFunctions {
/**
* @desc Creation of auxiliar resources ACP and AE for correct execution of the test case
* @param p_allowedOperations Allowed operations for the auxiliar AE resource
* @return Internal AE resource index
* @verdict
/**
* @desc Creation of auxiliar resources ACP and AE for correct execution of the test case
* @param p_allowedOperations Allowed operations for the auxiliar AE resource
* @return Internal AE resource index
* @verdict
*/
function f_preamble_registerAe(in template (value) AccessControlOperations p_allowedOperations := int63) runs on M2M return integer{//c_CRUDNDi
......@@ -118,9 +118,9 @@ module OneM2M_Functions {
group postambleFunctions {
/**
* @desc Deletion of all resources created during the test case execution. IUT gets clean and ready for next execution
* @verdict
/**
* @desc Deletion of all resources created during the test case execution. IUT gets clean and ready for next execution
* @verdict
*/
function f_postamble_deleteResources() runs on M2M {
var integer i;
......@@ -165,9 +165,9 @@ module OneM2M_Functions {
f_postamble_default();
}
/**
* @desc Ports unmapping
* @verdict
/**
* @desc Ports unmapping
* @verdict
*/
function f_postamble_default() runs on M2M {
......@@ -200,13 +200,13 @@ module OneM2M_Functions {
group getSetFunctions {
/**
* @desc Creation of a CREATE request primitive from a template request primitive
* @param p_resourceType Type of resource to be created
* @param p_request Template request primitive
* @param p_parentIndex Internal resource index which indicates the parent of the resource to be created
* @return Created CREATE request primitive
* @verdict
/**
* @desc Creation of a CREATE request primitive from a template request primitive
* @param p_resourceType Type of resource to be created
* @param p_request Template request primitive
* @param p_parentIndex Internal resource index which indicates the parent of the resource to be created
* @return Created CREATE request primitive
* @verdict
*/
function f_getCreateRequestPrimitive(in ResourceType p_resourceType, template RequestPrimitive p_request, integer p_parentIndex) runs on M2M return RequestPrimitive {
......@@ -244,13 +244,13 @@ module OneM2M_Functions {
return valueof(p_request);
}
/**
* @desc Creation of an UPDATE request primitive from a template request primitive
* @param p_resourceType Type of resource to be created
* @param p_resourceIndex Internal resource index which indicates the resource to be updated
* @param p_request Template request primitive
* @return Created UPDATE request primitive
* @verdict
/**
* @desc Creation of an UPDATE request primitive from a template request primitive
* @param p_resourceType Type of resource to be created
* @param p_resourceIndex Internal resource index which indicates the resource to be updated
* @param p_request Template request primitive
* @return Created UPDATE request primitive
* @verdict
*/
function f_getUpdateRequestPrimitive(in ResourceType p_resourceType, integer p_resourceIndex, template RequestPrimitive p_request) runs on M2M return RequestPrimitive {
......@@ -286,11 +286,11 @@ module OneM2M_Functions {
return valueof(p_request);
}
/**
* @desc Extraction from a primitiveContent field the resourceID attribute
* @param p_contentResource primitiveContent field
* @return resourceID attribute
* @verdict
/**
* @desc Extraction from a primitiveContent field the resourceID attribute
* @param p_contentResource primitiveContent field
* @return resourceID attribute
* @verdict
*/
function f_getResourceId(PrimitiveContent p_contentResource) return XSD.ID {
......@@ -319,11 +319,11 @@ module OneM2M_Functions {
}
/**
* @desc Extraction from a primitiveContent field the resourceName attribute
* @param p_contentResource primitiveContent field
* @return resourceName attribute
* @verdict
/**
* @desc Extraction from a primitiveContent field the resourceName attribute
* @param p_contentResource primitiveContent field
* @return resourceName attribute
* @verdict
*/
function f_getResourceName(PrimitiveContent p_contentResource) return XSD.ID {
......@@ -353,11 +353,11 @@ module OneM2M_Functions {
}
/**
* @desc Resolution of the originator field (from) for a given resource
* @param p_targetResourceIndex Internal resource index of the given resource
* @return Originator for a given resource
* @verdict
/**
* @desc Resolution of the originator field (from) for a given resource
* @param p_targetResourceIndex Internal resource index of the given resource
* @return Originator for a given resource
* @verdict
*/
function f_getOriginator(integer p_targetResourceIndex := -1) runs on M2M return XSD.AnyURI {
......@@ -376,12 +376,12 @@ module OneM2M_Functions {
}
}
/**
* @desc Return of a index of a specific attribute from an attributeList by attributeName
* @param p_attributeList Target attributeList
* @param p_attributeName attributeName to be searched
* @return Index of the attribute in the attributeList
* @verdict
/**
* @desc Return of a index of a specific attribute from an attributeList by attributeName
* @param p_attributeList Target attributeList
* @param p_attributeName attributeName to be searched
* @return Index of the attribute in the attributeList
* @verdict
*/
function f_getAttribute(in AttributeList p_attributeList, in XSD.NCName p_attributeName) return integer {
var integer i;
......@@ -397,11 +397,11 @@ module OneM2M_Functions {
}
/**
* @desc Resolution of the resource address field (to) for a given resource depending on addressing and hierarchical format
* @param p_targetResourceIndex Internal resource index of the given resource
* @return Resource address for the given resource
* @verdict
/**
* @desc Resolution of the resource address field (to) for a given resource depending on addressing and hierarchical format
* @param p_targetResourceIndex Internal resource index of the given resource
* @return Resource address for the given resource
* @verdict
*/
function f_getResourceAddress(integer p_targetResourceIndex := -1) runs on M2M return XSD.ID {
var XSD.ID v_resourceAddress;
......@@ -458,12 +458,12 @@ module OneM2M_Functions {
}
}
/**
* @desc Saving of a resource and its parent index in the internal resource list
* @param p_resource Resource to be saved
* @param p_parentIndex Parent index of resource to be saved
* @return Internal resource index of the saved resource
* @verdict
/**
* @desc Saving of a resource and its parent index in the internal resource list
* @param p_resource Resource to be saved
* @param p_parentIndex Parent index of resource to be saved
* @return Internal resource index of the saved resource
* @verdict
*/
function f_setResource(PrimitiveContent p_resource, integer p_parentIndex := -1) runs on M2M return integer {
......@@ -480,13 +480,13 @@ module OneM2M_Functions {
group helpingFunctions {
/**
* @desc Creation of a resource
* @param p_resourceType Resource type of the resource to be created
* @param p_requestPrimitive Template request primitive
* @param p_parentIndex Internal resource index which indicates the parent of the resource to be created
* @return Internal resource index of the created resource
* @verdict
/**
* @desc Creation of a resource
* @param p_resourceType Resource type of the resource to be created
* @param p_requestPrimitive Template request primitive
* @param p_parentIndex Internal resource index which indicates the parent of the resource to be created
* @return Internal resource index of the created resource
* @verdict
*/
function f_createResource(in ResourceType p_resourceType, template RequestPrimitive p_requestPrimitive, integer p_parentIndex := -1) runs on M2M return integer {
......@@ -522,12 +522,12 @@ module OneM2M_Functions {
}
/**
* @desc Creation of the auxiliar ACP resource
* @param p_acpName ACP name
* @param p_allowedOperations Allowed operations
* @return Internal resource index of the created auxiliar ACP resource
* @verdict
/**
* @desc Creation of the auxiliar ACP resource
* @param p_acpName ACP name
* @param p_allowedOperations Allowed operations
* @return Internal resource index of the created auxiliar ACP resource
* @verdict
*/
function f_createAccessControlPolicyAux(in template (value) XSD.String p_acpName := c_acpAuxName, in template (value) AccessControlOperations p_allowedOperations := int63) runs on M2M return integer{
var RequestPrimitive v_request;
......@@ -565,11 +565,11 @@ module OneM2M_Functions {
}
/**
* @desc Creation of the auxiliar Container resource
* @param p_parentIndex Internal resource index which indicates the parent of the Container resource to be created
* @return Internal resource index of the created Container resource
* @verdict
/**
* @desc Creation of the auxiliar Container resource
* @param p_parentIndex Internal resource index which indicates the parent of the Container resource to be created
* @return Internal resource index of the created Container resource
* @verdict
*/
function f_createContainerResourceAux (integer p_parentIndex := -1) runs on M2M return integer {
......@@ -590,10 +590,10 @@ module OneM2M_Functions {
}
/**
* @desc Update of the auxiliar ACP resource
* @param p_allowedOperations New allowed operations
* @verdict
/**
* @desc Update of the auxiliar ACP resource
* @param p_allowedOperations New allowed operations
* @verdict
*/
function f_updateAcpAuxResource (in template (value) AccessControlOperations p_allowedOperations) runs on M2M {
var RequestPrimitive v_request;
......
......@@ -7,7 +7,7 @@
*
* @author ETSI
* @version $URL: https://forge.etsi.org/svn/oneM2M/trunk/ttcn/OneM2M_Templates.ttcn $
* $Id: OneM2M_Templates.ttcn 99 2016-06-09 15:04:43Z reinaortega $
* $Id: OneM2M_Templates.ttcn 101 2016-07-08 15:41:06Z reinaortega $
* @desc Module containing templates for oneM2M
*
*/
......@@ -22,12 +22,12 @@ module OneM2M_Templates {
import from OneM2M_Functions all;
/**
* @desc Get a converted to string random number
* @param p_lower Lower limit
* @param p_upper Upper limit
* @return Random number converted to string
* @verdict
/**
* @desc Get a converted to string random number
* @param p_lower Lower limit
* @param p_upper Upper limit
* @return Random number converted to string
* @verdict
*/
function f_rnd(in integer p_lower, in integer p_upper) return charstring {
......@@ -79,10 +79,10 @@ module OneM2M_Templates {
discoveryResultType := omit
};
/**
* @desc Base RETRIEVE request primitive
* @param p_targetResourceAddress Target resource address
* @param p_originator Originator (from)
/**
* @desc Base RETRIEVE request primitive
* @param p_targetResourceAddress Target resource address
* @param p_originator Originator (from)
*/
template (value) RequestPrimitive m_retrieveResource(XSD.ID p_targetResourceAddress, in XSD.ID p_originator := PX_AE_ID_STEM) := {
operation := int2,
......@@ -133,11 +133,11 @@ module OneM2M_Templates {
discoveryResultType := omit
};
/**
* @desc RETRIEVE request primtive containing the target attributes in the primitiveContent field
* @param p_targetResourceAddress Target resource address
* @param p_attributeList Target attribute list
* @param p_originator Originator (from)
/**
* @desc RETRIEVE request primtive containing the target attributes in the primitiveContent field
* @param p_targetResourceAddress Target resource address
* @param p_attributeList Target attribute list
* @param p_originator Originator (from)
*/
template (value) RequestPrimitive m_retrieveResourceAttributeContentOption(XSD.ID p_targetResourceAddress, in template (value) AttributeList_1 p_attributeList, in XSD.ID p_originator := PX_AE_ID_STEM ) := {
operation := int2,
......@@ -166,8 +166,8 @@ module OneM2M_Templates {
group Update {
/**
* @desc Base UPDATE request primitive for Container resource
/**
* @desc Base UPDATE request primitive for Container resource
*/
template (value) RequestPrimitive m_updateContainerBase := {
operation := int3,
......@@ -795,10 +795,10 @@ module OneM2M_Templates {
group ContentCreate {
/**
* @desc Base primitiveContent for CREATE operation for AE resource
* @param p_name Resource name
* @param p_accessControlPolicyIDs ACP IDs for the AE
/**
* @desc Base primitiveContent for CREATE operation for AE resource
* @param p_name Resource name
* @param p_accessControlPolicyIDs ACP IDs for the AE
*/
template (value) AE_optional m_contentCreateAe (in template (omit) AcpType p_accessControlPolicyIDs, in template (omit) XSD.String p_name := c_defaultResourceName) := {
resourceName := p_name,//O
......@@ -823,11 +823,11 @@ module OneM2M_Templates {
choice := omit//NP
};
/**
* @desc Base primitiveContent for CREATE operation for AccessControlPolicy resource
* @param p_name Resource name
* @param p_acor Allowed originators
* @param p_allowedOperations Allowed operations
/**
* @desc Base primitiveContent for CREATE operation for AccessControlPolicy resource
* @param p_name Resource name
* @param p_acor Allowed originators
* @param p_allowedOperations Allowed operations
*/
template (value) AccessControlPolicy_optional m_contentCreateAcp (in template (omit) XSD.String p_name := c_defaultResourceName, in template (value) ListOfURIs p_acor := PX_ACOR, in template (value) AccessControlOperations p_allowedOperations := int63 ) := {
resourceName := p_name,//O
......@@ -861,12 +861,12 @@ module OneM2M_Templates {
choice := omit //NP
};
/**
* @desc Base primitiveContent for CREATE operation for Group resource
* @param p_maxNrOfMembers Max number of members
* @param p_memberIds Member IDs
* @param p_accessControlPolicyIDs ACP IDs for the Group
* @param p_name Resource name
/**
* @desc Base primitiveContent for CREATE operation for Group resource
* @param p_maxNrOfMembers Max number of members
* @param p_memberIds Member IDs
* @param p_accessControlPolicyIDs ACP IDs for the Group
* @param p_name Resource name
*/
template (value) Group_optional m_contentCreateGroup ( in template (value) XSD.NonNegativeInteger p_maxNrOfMembers,
in template (value) ListOfURIs p_memberIds,
......@@ -896,10 +896,10 @@ module OneM2M_Templates {
choice := omit//NP
};
/**
* @desc Base primitiveContent for CREATE operation for PollingChannel resource
* @param p_accessControlPolicyIDs ACP IDs for the PollingChannel
* @param p_name Resource name
/**
* @desc Base primitiveContent for CREATE operation for PollingChannel resource
* @param p_accessControlPolicyIDs ACP IDs for the PollingChannel
* @param p_name Resource name
*/
template (value) PollingChannel_optional m_contentCreatePollingChannel (in template (omit) AcpType p_accessControlPolicyIDs,
in template (omit) XSD.String p_name := c_defaultResourceName) := {
......@@ -915,10 +915,10 @@ module OneM2M_Templates {
pollingChannelURI := omit//NP
};
/**
* @desc Base primitiveContent for CREATE operation for Schedule resource
* @param p_scheduleElement Schedule
* @param p_name Resource name
/**
* @desc Base primitiveContent for CREATE operation for Schedule resource
* @param p_scheduleElement Schedule
* @param p_name Resource name
*/
template (value) Schedule_optional m_contentCreateSchedule (in template (value) ScheduleEntries p_scheduleElement,
in template (omit) XSD.String p_name := c_defaultResourceName) := {
......@@ -936,10 +936,10 @@ module OneM2M_Templates {
choice := omit//NP
};
/**
* @desc Base primitiveContent for CREATE operation for Subscription resource
* @param p_notificationURI Notification URI
* @param p_name Resource name
/**
* @desc Base primitiveContent for CREATE operation for Subscription resource
* @param p_notificationURI Notification URI
* @param p_name Resource name
*/
template (value) Subscription_optional m_contentCreateSubscription (in template (value) ListOfURIs p_notificationURI,
in template (omit) XSD.String p_name := c_defaultResourceName) := {
......@@ -970,9 +970,9 @@ module OneM2M_Templates {
choice := omit//NP
};
/**
* @desc Base primitiveContent for CREATE operation for ContentInstance resource
* @param p_primitiveContent Content for the ContentInstance
/**
* @desc Base primitiveContent for CREATE operation for ContentInstance resource
* @param p_primitiveContent Content for the ContentInstance
*/
template (value) ContentInstance_optional m_contentCreateContentInstance(XSD.String p_primitiveContent) := {
resourceName := c_defaultResourceName,//O
......@@ -997,9 +997,9 @@ module OneM2M_Templates {
}//M
};
/**
* @desc Base primitiveContent for CREATE operation for Container resource
* @param p_name Resource name
/**
* @desc Base primitiveContent for CREATE operation for Container resource
* @param p_name Resource name
*/
template (value) Container_optional m_contentCreateContainer (in template (omit) XSD.String p_name := c_defaultResourceName):= {
resourceName := p_name,//O
......@@ -1031,8 +1031,8 @@ module OneM2M_Templates {
group ContentUpdate {
/**
* @desc Base primitiveContent for UPDATE operation for AE resource
/**
* @desc Base primitiveContent for UPDATE operation for AE resource
*/
template (value) AE_optional m_contentUpdateAe := {
resourceName := omit,//NP
......@@ -1889,11 +1889,11 @@ module OneM2M_Templates {
};
}//end group ResponsePrimitives
/**
* @desc Get the prefix depending on the addressing format and binding (Temporal funciton as this should be done by TA)
* @param v_address Actual address
* @return Address with prefix
* @verdict
/**
* @desc Get the prefix depending on the addressing format and binding (Temporal funciton as this should be done by TA)
* @param v_address Actual address
* @return Address with prefix
* @verdict
*/
function f_addPrefix(XSD.ID v_address) return XSD.ID {
//TODO Test, to be removed
......
......@@ -7,7 +7,7 @@
*
* @author ETSI
* @version $URL: https://forge.etsi.org/svn/oneM2M/trunk/ttcn/OneM2M_TestSystem.ttcn $
* $Id: OneM2M_TestSystem.ttcn 99 2016-06-09 15:04:43Z reinaortega $
* $Id: OneM2M_TestSystem.ttcn 101 2016-07-08 15:41:06Z reinaortega $
* @desc Test System module for oneM2M
*
*/
......@@ -19,8 +19,8 @@ module OneM2M_TestSystem {
import from XSD all;
/* Ports */
/**
* @desc Port to transport oneM2M primitives
/**
* @desc Port to transport oneM2M primitives
*/
type port OneM2MPort message {
in
......@@ -29,8 +29,8 @@ module OneM2M_TestSystem {
M2MRequestPrimitive, M2MResponsePrimitive;
}
/**
* @desc Port to transport Adaptor Control primitives
/**
* @desc Port to transport Adaptor Control primitives
*/
type port AdapterControlPort message {
in
......@@ -62,14 +62,14 @@ module OneM2M_TestSystem {
}
/* Primitives */
/**
* @desc Type for the oneM2M primitives exchange
* @member requestPrimitive_ oneM2M primitive
* @member host IP Address of the destination
* @member xmlNamespace XML Namespace to be used
* @member protocolBinding Protocol binding to be used
* @member serialization Serialization to be used
* @member nullFields Fields that are to be included in the oneM2M primitive but empty, i.e. <labels></labels>
/**
* @desc Type for the oneM2M primitives exchange
* @member requestPrimitive_ oneM2M primitive
* @member host IP Address of the destination
* @member xmlNamespace XML Namespace to be used
* @member protocolBinding Protocol binding to be used
* @member serialization Serialization to be used
* @member nullFields Fields that are to be included in the oneM2M primitive but empty, i.e. <labels></labels>
*/
type record M2MRequestPrimitive {
RequestPrimitive requestPrimitive_,
......
......@@ -7,7 +7,7 @@
*
* @author ETSI
* @version $URL: https://forge.etsi.org/svn/oneM2M/trunk/ttcn/OneM2M_Testcases.ttcn $
* $Id: OneM2M_Testcases.ttcn 99 2016-06-09 15:04:43Z reinaortega $
* $Id: OneM2M_Testcases.ttcn 101 2016-07-08 15:41:06Z reinaortega $
* @desc Module containing test cases for oneM2M
*
*/
......
......@@ -7,7 +7,7 @@
*
* @author ETSI
* @version $URL: https://forge.etsi.org/svn/oneM2M/trunk/ttcn/OneM2M_Types.ttcn $
* $Id: OneM2M_Types.ttcn 99 2016-06-09 15:04:43Z reinaortega $
* $Id: OneM2M_Types.ttcn 101 2016-07-08 15:41:06Z reinaortega $
* @desc Test System module for oneM2M
*
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment