Aligned libcommon doc tags with t3doc 2.0 (50707859) · Commits · TTCN-3 Libraries / LibCommon

ttcn/LibCommon_AbstractData.ttcn

+9 −9

ttcn/LibCommon_BasicTypesAndValues.ttcn

+13 −13

Original line number	Original line	Diff line number	Diff line
	/*		/**
	* @author ETSI STF 276		* @author ETSI
	* @version $Id$		* @version $Id$
	* @desc A collection of basic type and value definitions which may be		* @desc A collection of basic type and value definitions which may be
	* useful in the implementation of any TTCN-3 test suite. <br><br>		* useful in the implementation of any TTCN-3 test suite. <br><br>
	@@ -11,7 +11,7 @@
	*/		*/
	module LibCommon_BasicTypesAndValues {		module LibCommon_BasicTypesAndValues {

	/*		/**
	* @remark Number in subtype name always indicates encoding length		* @remark Number in subtype name always indicates encoding length
	* in _bits_		* in _bits_
	*/		*/
	@@ -92,7 +92,7 @@

	} // end group unsignedIntegerDefintions		} // end group unsignedIntegerDefintions

	/*		/**
	* @remark Number in subtype name always indicates encoding length		* @remark Number in subtype name always indicates encoding length
	* in _bits_		* in _bits_
	*/		*/
	@@ -216,7 +216,7 @@

	}//end group zeroedInt		}//end group zeroedInt

	/*		/**
	* @remark Number in subtype name always indicates encoding length		* @remark Number in subtype name always indicates encoding length
	* in _bits_		* in _bits_
	*/		*/

ttcn/LibCommon_DataStrings.ttcn

+6 −5

Original line number	Original line	Diff line number	Diff line
	/*		/**
	* @author ETSI STF 276		*
			* @author ETSI
	* @version $Id$		* @version $Id$
	* @desc A collection of data string type and value definitions which		* @desc A collection of data string type and value definitions which
	* may be useful in the implementation of any TTCN-3 test		* may be useful in the implementation of any TTCN-3 test
	@@ -13,7 +14,7 @@
	*/		*/
	module LibCommon_DataStrings {		module LibCommon_DataStrings {

	/*		/**
	* @remark Number in name indicates string length in number of		* @remark Number in name indicates string length in number of
	* _bits_		* _bits_
	*/		*/
	@@ -73,7 +74,7 @@

	}//end group zeroedBits		}//end group zeroedBits

	/*		/**
	* @remark Number in name indicates string length in number of		* @remark Number in name indicates string length in number of
	* _octets_		* _octets_
	*/		*/

ttcn/LibCommon_Sync.ttcn

+74 −50

Original line number	Original line	Diff line number	Diff line
	/*		/**
	* @author ETSI STF 276		* @author ETSI
	* @version $Id$		* @version $Id$
	* @desc This module implements _one_ generic synchronization mechanism		* @desc This module implements _one_ generic synchronization mechanism
	* for TTCN-3 test cases with one or more test components.		* for TTCN-3 test cases with one or more test components.
	@@ -66,7 +66,7 @@ module LibCommon_Sync {

	group compTypeRelated {		group compTypeRelated {

	/*		/**
	* @desc This type is used to be the base of any synchronization		* @desc This type is used to be the base of any synchronization
	* behavior which is to be executed on a sync server		* behavior which is to be executed on a sync server
	* component. The test component which acts as a		* component. The test component which acts as a
	@@ -82,7 +82,7 @@ module LibCommon_Sync {
	timer tc_sync := PX_TSYNC_TIME_LIMIT;		timer tc_sync := PX_TSYNC_TIME_LIMIT;
	}		}

	/*		/**
	* @desc This type is used to define any synchronization		* @desc This type is used to define any synchronization
	* behavior which is to be executed on a sync server		* behavior which is to be executed on a sync server
	* component. The test component which acts as a		* component. The test component which acts as a
	@@ -101,7 +101,7 @@ module LibCommon_Sync {
	timer tc_sync := PX_TSYNC_TIME_LIMIT;		timer tc_sync := PX_TSYNC_TIME_LIMIT;
	} with { extension "extends BaseSyncComp" }		} with { extension "extends BaseSyncComp" }

	/*		/**
	* @desc This type is used to define any synchronization		* @desc This type is used to define any synchronization
	* behavior which is to be executed on a sync client		* behavior which is to be executed on a sync client
	* component. The test component(s) which act as a		* component. The test component(s) which act as a
	@@ -120,7 +120,7 @@ module LibCommon_Sync {
	timer tc_sync := PX_TSYNC_TIME_LIMIT;		timer tc_sync := PX_TSYNC_TIME_LIMIT;
	} with { extension "extends BaseSyncComp" }		} with { extension "extends BaseSyncComp" }

	/*		/**
	* @desc This type is used to define any synchronization		* @desc This type is used to define any synchronization
	* behavior which is relevant to non-concurrent test		* behavior which is relevant to non-concurrent test
	* cases.		* cases.
	@@ -142,7 +142,7 @@ module LibCommon_Sync {
	timer tc_sync := PX_TSYNC_TIME_LIMIT;		timer tc_sync := PX_TSYNC_TIME_LIMIT;
	} with { extension "extends ClientSyncComp" }		} with { extension "extends ClientSyncComp" }

	/*		/**
	* @desc This port type must be imported into test suites		* @desc This port type must be imported into test suites
	* when defining test component types which are		* when defining test component types which are
	* type compatible to a synchronization component		* type compatible to a synchronization component
	@@ -166,7 +166,8 @@ module LibCommon_Sync {

	group syncCompTestConfiguration {		group syncCompTestConfiguration {

	/* @desc Calls self connect function if invoking		/**
			* @desc Calls self connect function if invoking
	* component is the MTC or otherwise connects the client		* component is the MTC or otherwise connects the client
	* the server. This function allows to implement preambles		* the server. This function allows to implement preambles
	* in a way that they can be used by test components		* in a way that they can be used by test components
	@@ -188,7 +189,8 @@ module LibCommon_Sync {
	}		}
	}		}

	/* @desc Calls self connect function if the invoking		/**
			* @desc Calls self connect function if the invoking
	* component is the MTC or otherwise disconnects the client		* component is the MTC or otherwise disconnects the client
	* from the server. This function allows to implement		* from the server. This function allows to implement
	* postambles in a way that they can be used in both		* postambles in a way that they can be used in both
	@@ -213,7 +215,8 @@ module LibCommon_Sync {

	group syncFunctions {		group syncFunctions {

	/* @desc Implements synchronization of 2 clients from server side		/**
			* @desc Implements synchronization of 2 clients from server side
	* on one or more synchronization points.		* on one or more synchronization points.
	* If problem occurs, then server sends STOP to all clients.		* If problem occurs, then server sends STOP to all clients.
	* Waits for PX_TSYNC_TIME_LIMIT to let clients		* Waits for PX_TSYNC_TIME_LIMIT to let clients
	@@ -231,7 +234,6 @@ module LibCommon_Sync {
	* @see LibCommon_Sync.f_serverSyncClientsTimed		* @see LibCommon_Sync.f_serverSyncClientsTimed
	* @see LibCommon_Sync.f_serverWaitForAllClientsToStop		* @see LibCommon_Sync.f_serverWaitForAllClientsToStop
	* @param p_syncPointIds list of synchronization point name/ids		* @param p_syncPointIds list of synchronization point name/ids
	* @return execution status
	*/		*/
	function f_serverSync2ClientsAndStop( in SyncPointList p_syncPointIds )		function f_serverSync2ClientsAndStop( in SyncPointList p_syncPointIds )
	runs on ServerSyncComp {		runs on ServerSyncComp {
	@@ -242,7 +244,8 @@ module LibCommon_Sync {
	f_serverWaitForAllClientsToStop();		f_serverWaitForAllClientsToStop();
	}		}

	/* @desc Implements synchronization of 3 clients from server side		/**
			* @desc Implements synchronization of 3 clients from server side
	* on one or more synchronization points.		* on one or more synchronization points.
	* If problem occurs, then server sends STOP to all clients.		* If problem occurs, then server sends STOP to all clients.
	* Waits for PX_TSYNC_TIME_LIMIT to let clients		* Waits for PX_TSYNC_TIME_LIMIT to let clients
	@@ -260,7 +263,6 @@ module LibCommon_Sync {
	* @see LibCommon_Sync.f_serverSyncClientsTimed		* @see LibCommon_Sync.f_serverSyncClientsTimed
	* @see LibCommon_Sync.f_serverWaitForAllClientsToStop		* @see LibCommon_Sync.f_serverWaitForAllClientsToStop
	* @param p_syncPointIds list of synchronization point name/ids		* @param p_syncPointIds list of synchronization point name/ids
	* @return execution status
	*/		*/
	function f_serverSync3ClientsAndStop( in SyncPointList p_syncPointIds )		function f_serverSync3ClientsAndStop( in SyncPointList p_syncPointIds )
	runs on ServerSyncComp {		runs on ServerSyncComp {
	@@ -271,7 +273,8 @@ module LibCommon_Sync {
	f_serverWaitForAllClientsToStop();		f_serverWaitForAllClientsToStop();
	}		}

	/* @desc Implements synchronization of N clients from server side		/**
			* @desc Implements synchronization of N clients from server side
	* on one or more synchronization points.		* on one or more synchronization points.
	* If problem occurs, then server sends STOP to all clients.		* If problem occurs, then server sends STOP to all clients.
	* Waits for PX_TSYNC_TIME_LIMIT to let clients		* Waits for PX_TSYNC_TIME_LIMIT to let clients
	@@ -290,7 +293,6 @@ module LibCommon_Sync {
	* @see LibCommon_Sync.f_serverWaitForAllClientsToStop		* @see LibCommon_Sync.f_serverWaitForAllClientsToStop
	* @param p_numClients number of synchronization clients		* @param p_numClients number of synchronization clients
	* @param p_syncPointIds list of synchronization point name/ids		* @param p_syncPointIds list of synchronization point name/ids
	* @return execution status
	*/		*/
	function f_serverSyncNClientsAndStop (		function f_serverSyncNClientsAndStop (
	in integer p_numClients,		in integer p_numClients,
	@@ -306,7 +308,8 @@ module LibCommon_Sync {
	f_serverWaitForAllClientsToStop();		f_serverWaitForAllClientsToStop();
	}		}

	/* @desc Implements synchronization of 2 clients and 1 UT from server side		/**
			* @desc Implements synchronization of 2 clients and 1 UT from server side
	* on one or more synchronization points.		* on one or more synchronization points.
	* If problem occurs, then server sends STOP to all clients.		* If problem occurs, then server sends STOP to all clients.
	* Waits for PX_TSYNC_TIME_LIMIT to let clients		* Waits for PX_TSYNC_TIME_LIMIT to let clients
	@@ -324,7 +327,6 @@ module LibCommon_Sync {
	* @see LibCommon_Sync.f_serverSyncClientsTimed		* @see LibCommon_Sync.f_serverSyncClientsTimed
	* @see LibCommon_Sync.f_serverWaitForAllClientsToStop		* @see LibCommon_Sync.f_serverWaitForAllClientsToStop
	* @param p_syncPointIds list of synchronization point name/ids		* @param p_syncPointIds list of synchronization point name/ids
	* @return execution status
	*/		*/
	function f_serverSync2ClientsUtAndStop( in SyncPointList p_syncPointIds )		function f_serverSync2ClientsUtAndStop( in SyncPointList p_syncPointIds )
	runs on ServerSyncComp {		runs on ServerSyncComp {
	@@ -335,7 +337,8 @@ module LibCommon_Sync {
	f_serverWaitForAllClientsToStop();		f_serverWaitForAllClientsToStop();
	}		}

	/* @desc Calls either self synchronization function if		/**
			* @desc Calls either self synchronization function if
	* invoking component is the MTC, otherwise		* invoking component is the MTC, otherwise
	* calls client synchronization. After that it		* calls client synchronization. After that it
	* sets the verdict based on the specified return code.		* sets the verdict based on the specified return code.
	@@ -362,7 +365,8 @@ module LibCommon_Sync {
	}		}
	}		}

	/* @desc Calls either self synchronization function if		/**
			* @desc Calls either self synchronization function if
	* invoking component is the MTC, otherwise		* invoking component is the MTC, otherwise
	* calls client synchronization. After that it		* calls client synchronization. After that it
	* sets a preamble specific verdict based on the		* sets a preamble specific verdict based on the
	@@ -394,7 +398,8 @@ module LibCommon_Sync {

	group syncCompStateHandling {		group syncCompStateHandling {

	/*		/**
			*
	* @desc This function updates the state (stack) of a		* @desc This function updates the state (stack) of a
	* sync client or self sync component. This stack is		* sync client or self sync component. This stack is
	* key in the shutdown handling of test components.		* key in the shutdown handling of test components.
	@@ -424,7 +429,8 @@ module LibCommon_Sync {
	}		}
	} // end function f_addSyncCompState		} // end function f_addSyncCompState

	/*		/**
			*
	* @desc This function returns the top state on the sync		* @desc This function returns the top state on the sync
	* state stack of a sync client or self sync		* state stack of a sync client or self sync
	* component and removes it from the stack		* component and removes it from the stack
	@@ -458,7 +464,8 @@ module LibCommon_Sync {
	f_popStringStack(v_stateStack);		f_popStringStack(v_stateStack);
	} // end function f_popSyncCompState		} // end function f_popSyncCompState

	/*		/**
			*
	* @desc This function returns the top state on the sync state		* @desc This function returns the top state on the sync state
	* stack of a sync client or self sync component. It		* stack of a sync client or self sync component. It
	* does not remove it from the stack		* does not remove it from the stack
	@@ -474,7 +481,7 @@ module LibCommon_Sync {
	return f_peekStringStackTop(v_stateStack,p_state);		return f_peekStringStackTop(v_stateStack,p_state);
	} // end function f_peekTopSyncCompState		} // end function f_peekTopSyncCompState

	/*		/**
	* @desc This function checks if the sync state stack		* @desc This function checks if the sync state stack
	* of a sync client or self sync component is empty.		* of a sync client or self sync component is empty.
	* This stack is key in the shutdown handling of test		* This stack is key in the shutdown handling of test
	@@ -491,7 +498,8 @@ module LibCommon_Sync {

	group exampleShutDownAltstep {		group exampleShutDownAltstep {

	/* @desc This is an example of a shutdown altstep which can be		/**
			* @desc This is an example of a shutdown altstep which can be
	* used as a "template" for a interface specific shutdown		* used as a "template" for a interface specific shutdown
	* altstep or possily as a first temporary solution in		* altstep or possily as a first temporary solution in
	* test case development.<br><br>		* test case development.<br><br>
	@@ -551,7 +559,8 @@ module LibCommon_Sync {

	group serverRelated {		group serverRelated {

	/* @desc Implements synchronization of "n" clients from server		/**
			* @desc Implements synchronization of "n" clients from server
	* side. If a problem occurs, then server sends STOP to		* side. If a problem occurs, then server sends STOP to
	* all clients. Waits for PX_TSYNC_TIME_LIMIT to let		* all clients. Waits for PX_TSYNC_TIME_LIMIT to let
	* clients finish executing their behavior until this		* clients finish executing their behavior until this
	@@ -565,14 +574,14 @@ module LibCommon_Sync {
	* @see LibCommon_Sync.f_serverSyncClientsTimed		* @see LibCommon_Sync.f_serverSyncClientsTimed
	* @param p_noOfClients number of clients to be synchronized		* @param p_noOfClients number of clients to be synchronized
	* @param p_syncId synchronization point name/id		* @param p_syncId synchronization point name/id
	* @return execution status
	*/		*/
	function f_serverSyncClients( in UInt p_noOfClients, in charstring p_syncId )		function f_serverSyncClients( in UInt p_noOfClients, in charstring p_syncId )
	runs on ServerSyncComp {		runs on ServerSyncComp {
	f_serverSyncClientsTimed(p_noOfClients,p_syncId, PX_TSYNC_TIME_LIMIT);		f_serverSyncClientsTimed(p_noOfClients,p_syncId, PX_TSYNC_TIME_LIMIT);
	}		}

	/* @desc Handles synchronization of clients from server side.		/**
			* @desc Handles synchronization of clients from server side.
	* If problem occurs, then server sends STOP to all clients.		* If problem occurs, then server sends STOP to all clients.
	* This function sets the server verdict.		* This function sets the server verdict.
	* @remark The use of this function requires prior connection of		* @remark The use of this function requires prior connection of
	@@ -582,7 +591,6 @@ module LibCommon_Sync {
	* @param p_execTimeLimit time limit given to all clients to finish the execution		* @param p_execTimeLimit time limit given to all clients to finish the execution
	* of their behavior up to this synchronization point		* of their behavior up to this synchronization point
	* @see LibCommon_Sync.f_connect4SelfOrClientSync		* @see LibCommon_Sync.f_connect4SelfOrClientSync
	* @return execution status
	*/		*/
	function f_serverSyncClientsTimed( in UInt p_NoOfClients,		function f_serverSyncClientsTimed( in UInt p_NoOfClients,
	in charstring p_syncId,		in charstring p_syncId,
	@@ -653,7 +661,7 @@ module LibCommon_Sync {
	}		}
	} // end function f_serverSyncClientsTimed		} // end function f_serverSyncClientsTimed

	/*		/**
	* @desc This function is intended only for use on the sync		* @desc This function is intended only for use on the sync
	* server component in concurrent TTCN-3 test cases.		* server component in concurrent TTCN-3 test cases.
	* It waits for all components to finish execution within		* It waits for all components to finish execution within
	@@ -681,7 +689,8 @@ module LibCommon_Sync {

	group clientRelated {		group clientRelated {

	/* @desc This function creates the connection needed to		/**
			* @desc This function creates the connection needed to
	* execute client synchronization functions		* execute client synchronization functions
	* @see LibCommon_Sync.f_clientSync		* @see LibCommon_Sync.f_clientSync
	* @see LibCommon_Sync.f_clientSendStop		* @see LibCommon_Sync.f_clientSendStop
	@@ -691,7 +700,8 @@ module LibCommon_Sync {
	connect(self:syncPort, mtc:syncPort);		connect(self:syncPort, mtc:syncPort);
	}// end function f_connect4ClientSync		}// end function f_connect4ClientSync

	/* @desc This function removes the connection needed		/**
			* @desc This function removes the connection needed
	* to execute client synchronization functions		* to execute client synchronization functions
	* @see LibCommon_Sync.f_clientSync		* @see LibCommon_Sync.f_clientSync
	* @see LibCommon_Sync.f_clientSendStop		* @see LibCommon_Sync.f_clientSendStop
	@@ -701,7 +711,8 @@ module LibCommon_Sync {
	disconnect(self:syncPort, mtc:syncPort);		disconnect(self:syncPort, mtc:syncPort);
	}// end function f_disconnect4ClientSync		}// end function f_disconnect4ClientSync

	/* @desc This function combines client verdict setting with its		/**
			* @desc This function combines client verdict setting with its
	* synchronization for use after or within a preamble		* synchronization for use after or within a preamble
	* implementation.		* implementation.
	* Note that such preambles can _not_ be reused in non-		* Note that such preambles can _not_ be reused in non-
	@@ -722,7 +733,8 @@ module LibCommon_Sync {
	f_clientSync(p_syncId,p_ret);		f_clientSync(p_syncId,p_ret);
	}		}

	/* @desc This function combines client verdict setting with its		/**
			* @desc This function combines client verdict setting with its
	* synchronization for use,e.g, after or within a		* synchronization for use,e.g, after or within a
	* test body implementation.		* test body implementation.
	* Note that such premables can _not_ be reused in non-		* Note that such premables can _not_ be reused in non-
	@@ -745,7 +757,8 @@ module LibCommon_Sync {
	f_clientSync(p_syncId,p_ret);		f_clientSync(p_syncId,p_ret);
	}		}

	/* @desc This function combines client verdict setting with its		/**
			* @desc This function combines client verdict setting with its
	* synchronization for use after or within a		* synchronization for use after or within a
	* postamble implementation.		* postamble implementation.
	* Note that such prostambles can _not_ be reused in non-		* Note that such prostambles can _not_ be reused in non-
	@@ -766,7 +779,8 @@ module LibCommon_Sync {
	f_clientSync(p_syncId,p_ret);		f_clientSync(p_syncId,p_ret);
	}		}

	/* @desc This function handles synchronization of a sync client		/**
			* @desc This function handles synchronization of a sync client
	* with the server. In case of successful execution it sends		* with the server. In case of successful execution it sends
	* a READY message to the server and waits the READY back.		* a READY message to the server and waits the READY back.
	* The time used for waiting is defined by PX_TSYNC_TIME_LIMIT.		* The time used for waiting is defined by PX_TSYNC_TIME_LIMIT.
	@@ -822,7 +836,8 @@ module LibCommon_Sync {

	} // end function f_clientSync		} // end function f_clientSync

	/* @desc This function can be used to request the shutdown a		/**
			* @desc This function can be used to request the shutdown a
	* multi component test case _prior_ to reaching a		* multi component test case _prior_ to reaching a
	* synchronization point. It sends a STOP message to		* synchronization point. It sends a STOP message to
	* the sync server and awaits then the STOP from the server		* the sync server and awaits then the STOP from the server
	@@ -864,7 +879,8 @@ module LibCommon_Sync {
	group otherSyncModuleDefinitions {		group otherSyncModuleDefinitions {

	group syncModuleparams {		group syncModuleparams {
	/*		/**
			*
	* @desc Default time limit for a sync client to reach a		* @desc Default time limit for a sync client to reach a
	* synchronization point		* synchronization point
	*/		*/
	@@ -887,7 +903,8 @@ module LibCommon_Sync {

	group otherSelfSyncRelatedDefinitions {		group otherSelfSyncRelatedDefinitions {

	/* @desc This function creates the connection needed to		/**
			* @desc This function creates the connection needed to
	* execute self sync functions		* execute self sync functions
	* @see LibCommon_Sync.f_selfSync		* @see LibCommon_Sync.f_selfSync
	* @see LibCommon_Sync.f_selfSyncStop		* @see LibCommon_Sync.f_selfSyncStop
	@@ -897,7 +914,8 @@ module LibCommon_Sync {
	connect(self:syncSendPort, self:syncPort);		connect(self:syncSendPort, self:syncPort);
	}// end function f_connect4SelfSync		}// end function f_connect4SelfSync

	/* @desc This function removes the connection needed		/**
			* @desc This function removes the connection needed
	* to execute self sync functions		* to execute self sync functions
	* @see LibCommon_Sync.f_selfSync		* @see LibCommon_Sync.f_selfSync
	* @see LibCommon_Sync.f_selfSyncStop		* @see LibCommon_Sync.f_selfSyncStop
	@@ -907,7 +925,8 @@ module LibCommon_Sync {
	disconnect(self:syncSendPort, self:syncPort);		disconnect(self:syncSendPort, self:syncPort);
	}// end function f_disconnect4SelfSync		}// end function f_disconnect4SelfSync

	/* @desc This function combines MTC verdict setting with self		/**
			* @desc This function combines MTC verdict setting with self
	* synchronization for use after and possibly in the test body		* synchronization for use after and possibly in the test body
	* @param p_syncId Synchronization point name/id		* @param p_syncId Synchronization point name/id
	* @param p_ret Current behavior execution status		* @param p_ret Current behavior execution status
	@@ -922,7 +941,8 @@ module LibCommon_Sync {
	f_selfSync(p_syncId,p_ret);		f_selfSync(p_syncId,p_ret);
	}		}

	/* @desc This function combines MTC verdict setting with self		/**
			* @desc This function combines MTC verdict setting with self
	* synchronization for use after the preamble.		* synchronization for use after the preamble.
	* @param p_syncId Synchronization point name/id		* @param p_syncId Synchronization point name/id
	* @param p_ret Current behavior execution status		* @param p_ret Current behavior execution status
	@@ -936,7 +956,8 @@ module LibCommon_Sync {
	f_selfSync(p_syncId,p_ret);		f_selfSync(p_syncId,p_ret);
	}		}

	/* @desc This function combines MTC verdict setting with self		/**
			* @desc This function combines MTC verdict setting with self
	* synchronization for use after the postamble.		* synchronization for use after the postamble.
	* @param p_syncId Synchronization point name/id		* @param p_syncId Synchronization point name/id
	* @param p_ret Current behavior execution status		* @param p_ret Current behavior execution status
	@@ -950,7 +971,8 @@ module LibCommon_Sync {
	f_selfSync(p_syncId,p_ret);		f_selfSync(p_syncId,p_ret);
	}		}

	/* @desc This function synchronizes a MTC with itself. In case		/**
			* @desc This function synchronizes a MTC with itself. In case
	* of a non successful execution status it sends a STOP		* of a non successful execution status it sends a STOP
	* message to itself and invokes that way the		* message to itself and invokes that way the
	* shutdown default (if activated).		* shutdown default (if activated).
	@@ -982,7 +1004,8 @@ module LibCommon_Sync {
	return e_success ;		return e_success ;
	}// end function f_selfSync		}// end function f_selfSync

	/* @desc This function can be used to shut down a test case _prior_		/**
			* @desc This function can be used to shut down a test case _prior_
	* to reaching a synchronization point. it sends a STOP		* to reaching a synchronization point. it sends a STOP
	* message to itself and invokes that way the		* message to itself and invokes that way the
	* shutdown default (if activated).		* shutdown default (if activated).
	@@ -1012,7 +1035,8 @@ module LibCommon_Sync {

	} // end group otherSelfSyncRelatedDefinitions		} // end group otherSelfSyncRelatedDefinitions

	/*		/**
			*
	* @desc The sychronization protocol is conceptually based on		* @desc The sychronization protocol is conceptually based on
	* named synchronization. Each synchronization point		* named synchronization. Each synchronization point
	* has it own specific synchronization message. This		* has it own specific synchronization message. This
	@@ -1064,7 +1088,7 @@ module LibCommon_Sync {

	group otherSyncFunctions {		group otherSyncFunctions {

	/*		/**
	* @desc Makes server send a sync message to all known clients		* @desc Makes server send a sync message to all known clients
	* @param p_clientRefs List of client references to which the message is to be send		* @param p_clientRefs List of client references to which the message is to be send
	* @param p_syncCmd The actual synchronization message to be sent out		* @param p_syncCmd The actual synchronization message to be sent out
	@@ -1078,7 +1102,7 @@ module LibCommon_Sync {
	}		}
	} // end function f_serverSendToAllClients		} // end function f_serverSendToAllClients

	/*		/**
	* @desc This function is intended only for use on server in concurrent		* @desc This function is intended only for use on server in concurrent
	* TTCN-3 test cases. It waits for all components to shut down		* TTCN-3 test cases. It waits for all components to shut down
	* within the PX_TSHUT_DOWN_TIME_LIMIT. If a timeout occurs		* within the PX_TSHUT_DOWN_TIME_LIMIT. If a timeout occurs

ttcn/LibCommon_TextStrings.ttcn

+21 −7

Original line number	Original line	Diff line number	Diff line
	/*		/**
	* @author ETSI STF 276		* @author ETSI
	* @version $Id$		* @version $Id$
	* @desc A collection of text string type and value definitions which		* @desc A collection of text string type and value definitions which
	* may be useful in the implementation of any TTCN-3 test		* may be useful in the implementation of any TTCN-3 test
	@@ -13,7 +13,7 @@
	*/		*/
	module LibCommon_TextStrings language "TTCN-3:2005" {		module LibCommon_TextStrings language "TTCN-3:2005" {

	/*		/**
	* @desc These constants can be used to add special characters into		* @desc These constants can be used to add special characters into
	* TTCN-3 text strings by using the concatenation operator.		* TTCN-3 text strings by using the concatenation operator.
	* Example use:		* Example use:
	@@ -59,7 +59,7 @@ module LibCommon_TextStrings language "TTCN-3:2005" {

	} // end group usefulConstants		} // end group usefulConstants

	/*		/**
	* @remark Number in name indicates string length in number of		* @remark Number in name indicates string length in number of
	* _characters_		* _characters_
	*/		*/
	@@ -98,10 +98,24 @@ module LibCommon_TextStrings language "TTCN-3:2005" {
	type universal charstring UnicodeText1to255 length(1..255)		type universal charstring UnicodeText1to255 length(1..255)
	with {encode "length(1..255)"};		with {encode "length(1..255)"};

	type charstring AlphaNum ("0".."9","a".."z","A".."Z");		/**
	type AlphaNum AlphaNum2 length(2) with { encode "length(2)"};		* @desc Subtyping can not be used in this type definition to ensure
	type AlphaNum AlphaNum1To32 length(1..32) with {encode "length(1..32)"};		* values of this type are really alphanumeric.
			* Instead either codecs or a template have
			* to be used for this purpose. The type is kept here to ensure
			* backward compatibility.
			* @see LibCommon_TextStrings.mw_isAlphaNum
			*/
			type charstring AlphaNum with { encode "alphanumeric"};
			type AlphaNum AlphaNum2 length(2) with { encode "alphanumeric;length(2)"};
			type AlphaNum AlphaNum1To32 length(1..32) with {encode "alphanumeric;length(1..32)"};

	} // end group usefulTextStringTypes		} // end group usefulTextStringTypes

			group usefulTextStringTemplates {

			template charstring mw_isAlphaNum := pattern "([0-9]\|[a-z]\|[A-Z])+";

			} // end group usefulTextStringTemplates

	} // end module LibCommon_TextStrings		} // end module LibCommon_TextStrings

Admin message