Named Objects Library - Revision history

Pw3r at 01:13, 2 March 2022

2022-03-02T01:13:22Z

← Older revision		Revision as of 01:13, 2 March 2022
Line 8:		Line 8:


	The '''Named Objects Library''' is a library that may be used to manage information about available named objects in the current session. The library can manage cached data for several common objects type, which can be individually asynchronously refreshed in the background using internal threads inside the library, and can return at any time synchronously the content of any of the managed caches.		The '''Named Objects Library''' is a 3rd party script library that may be used to manage information about available named objects in the current session. The library can manage cached data for several common objects type, which can be individually asynchronously refreshed in the background using internal threads inside the library, and can return at any time synchronously the content of any of the managed caches.

	Usually, an asset using the Named Objects Library will first load and initialize the library in its init routine, will then register the objects type to be cached in the library (which will immediately start the asynchronous process of collecting the cached data for this object type), and will later use the cached data by calling the library to retrieve the current cached data.		Usually, an asset using the Named Objects Library will first load and initialize the library in its init routine, will then register the objects type to be cached in the library (which will immediately start the asynchronous process of collecting the cached data for this object type), and will later use the cached data by calling the library to retrieve the current cached data.

Pguy: /* Named Objects Library : How to register the objects type you want to be cached by the library */

2020-10-23T17:06:30Z

Named Objects Library : How to register the objects type you want to be cached by the library

← Older revision		Revision as of 17:06, 23 October 2020
Line 116:		Line 116:
	where cacheType defines the type of objects to be cached		where cacheType defines the type of objects to be cached
	searchfilter is an optional string to limit the search to all objects whose name are prefixed by searchfilter		searchfilter is an optional string to limit the search to all objects whose name are prefixed by searchfilter
	autoupdate is now an obsolete bool parameter that will be ignored. autoupdate is always done in surveyor ~~mode every 5 seconds~~ and ~~only for consists in~~ driver mode ~~every 5 seconds~~.		autoupdate is now an obsolete bool parameter that will be ignored. autoupdate is always done in both surveyor and driver mode when needed.
	notifyGameObject is an optional GameObject reference that will receive a message "Noclib","CacheRefreshComplete" when the cached data will be available (Cf RefreshNamedObjectsCache below)		notifyGameObject is an optional GameObject reference that will receive a message "Noclib","CacheRefreshComplete" when the cached data will be available (Cf RefreshNamedObjectsCache below)

Line 127:		Line 127:
	Depending on the number of objects to scan and retrieve in your route, the duration of a cache refresh operation may last from a few miliseconds to several seconds.		Depending on the number of objects to scan and retrieve in your route, the duration of a cache refresh operation may last from a few miliseconds to several seconds.
	If you want to be sure that the implicit cache refresh operation is complete, you will need to wait for the "Noclib","CacheRefreshComplete" message to be received by the notifyGameObject and check that the parameter soup included in the message has the expected cache type (cachetype tag), search filter (searchfilter tag) and refresh serial value (refreshserialvalue tag) for the cache refresh operation just being completed.		If you want to be sure that the implicit cache refresh operation is complete, you will need to wait for the "Noclib","CacheRefreshComplete" message to be received by the notifyGameObject and check that the parameter soup included in the message has the expected cache type (cachetype tag), search filter (searchfilter tag) and refresh serial value (refreshserialvalue tag) for the cache refresh operation just being completed.
	It is also possible to call IsNamedObjectsCacheRefreshComplete described later in this documentation with the cache type, search filter and refresh sequential number to check.		It is also possible to call IsNamedObjectsCacheRefreshComplete described later in this documentation with the cache type, search filter and refresh sequential number to check cache refresh is complete.


	Cached data supports the search results expiry notification option included in Tane SP2 and will redo an automatic cache refresh operation if the current cached data expires. This means that ~~rename~~ or deletion of ~~objects should~~ be detected and cached data will be ~~then~~ refreshed. ~~New objects added are not so easily detected : that is why all cached data~~ is ~~refreshed every 5 seconds in surveyor mode and~~ only ~~consist cached data is refreshed every 5 seconds in driver mode, so that cached data contains the most recent data with~~ a latency of 5 seconds for ~~performance reason~~.		Cached data supports the search results expiry notification option included in Tane SP2 and will redo an automatic cache refresh operation if the current cached data expires. This means that adding a new object or renaming or deletion of an existing object will be detected and cached data will be refreshed. There is only a little latency of a few seconds for the cache update before the new cache content is available.


	AddNamedObjectsTypeToCache are generally located in the Init function of your asset and you need to make one call for each of the objects type to be cached.		AddNamedObjectsTypeToCache are generally located in the Init function of your asset and you need to make one call for each of the objects type to be cached.

Pguy: /* Named Objects Library : How to use it ? */

2020-10-23T16:49:09Z

Named Objects Library : How to use it ?

← Older revision		Revision as of 16:49, 23 October 2020
Line 23:		Line 23:
	To use the Named Object Library in any of your assets, you need first to modify its config.txt file to add the Named Objects Library in its kuid table section and in its script include table so that your asset can reference the Named Objects Library to import the Named Object Library API as a static class nochelper contained in nochelper.gs inside the Named Objects Library Asset.		To use the Named Object Library in any of your assets, you need first to modify its config.txt file to add the Named Objects Library in its kuid table section and in its script include table so that your asset can reference the Named Objects Library to import the Named Object Library API as a static class nochelper contained in nochelper.gs inside the Named Objects Library Asset.

	The current Named Objects Library available on DLS is <kuid2:61392:4053:10~~> but there~~ will be ~~soon a~~ new ~~release 11 <kuid2:61392:4053:11> that will bring supports for track circuit blocks objects~~.		The current Named Objects Library available on DLS is <kuid2:61392:4053:22> [for date 23/10/2020].
			There will be in the future new versions to add new cache types and fix any remaining bugs.

	Your asset config.txt file should include the following sections to be able to load the Named Objects Library API as nochelper static class :		Your asset config.txt file should include the following sections to be able to load the Named Objects Library API as nochelper static class :
Line 39:		Line 40:
	{		{
	. . .		. . .
	noclib <kuid2:61392:4053:10>		noclib <kuid2:61392:4053:22>
	. . .		. . .
	}		}

Pguy: /* Named Objects Library (SP2 and later) */

2020-10-23T16:43:55Z

Named Objects Library (SP2 and later)

← Older revision		Revision as of 16:43, 23 October 2020
Line 8:		Line 8:


	The '''Named Objects Library''' is a library that may be used to manage information about available named objects in the current session. The library can manage cached data for several common objects type, which can be individually asynchronously refreshed in the background using threads inside the library, and can return at any time synchronously the content of any of the managed caches.		The '''Named Objects Library''' is a library that may be used to manage information about available named objects in the current session. The library can manage cached data for several common objects type, which can be individually asynchronously refreshed in the background using internal threads inside the library, and can return at any time synchronously the content of any of the managed caches.

	Usually, an asset using the Named Objects Library will first load and initialize the library in its init routine, will then register the objects type to be cached in the library (which will immediately start the asynchronous process of collecting the cached data for this object type), and will later use the cached data by calling the library to retrieve the current cached data.		Usually, an asset using the Named Objects Library will first load and initialize the library in its init routine, will then register the objects type to be cached in the library (which will immediately start the asynchronous process of collecting the cached data for this object type), and will later use the cached data by calling the library to retrieve the current cached data.
	The library uses all the new object search API available since Tane SP2 and will automaticly refresh in the background any expired cache data~~. Also under surveyor mode, all cached data are refreshed every 5 seconds to include new added objects edited under~~ surveyor ~~; under~~ driver mode ~~only consists cached data are refreshed every 5 seconds to ensure that consists emited from portals are added to the cached data~~.		The library uses all the new object search API available since Tane SP2 and will automaticly refresh in the background any expired cache data in both surveyor and driver mode.


	Named Objects Library has been designed and developped to support the new search request Tane SP2 API for all the assets by pguy. It is not a general purpose API interface but an adapted interface to make Tane SP2 migration easy for pguy's assets. The API is now published and public, as it may be interesting for some other scripters that have not already done this migration to use this library for their own migration to the new interfaces.		Named Objects Library has been designed and developped to support the new search request Tane SP2 API for all the assets by pguy. It is not a general purpose API interface but an adapted interface to make Tane SP2 migration easy for pguy's assets. The API is now published and public, as it may be interesting for some other scripters that have not already done this migration to use this library for their own migration to the new interfaces.

Pguy: /* Named Objects Library : alternative RetrieveNamedObjects API */

2018-12-28T14:54:27Z

Named Objects Library : alternative RetrieveNamedObjects API

← Older revision		Revision as of 14:54, 28 December 2018
Line 269:		Line 269:
	public NamedObjectInfo[] RetrieveNamedObjects(int cacheType,string[] searchFilters) ;		public NamedObjectInfo[] RetrieveNamedObjects(int cacheType,string[] searchFilters) ;

	These functions enables to return in a unique ~~NamedObjectInof~~ array objects of ~~rthe~~ same cacheType matching several searchFilters with some results coming from already existing data cached and other results being only new search results not cached.		These functions enables to return in a unique NamedObjectInfo array objects of the same cacheType matching several searchFilters with some results coming from already existing data cached and other results being only new search results not cached.

	=== Named Objects Library : other miscellaneous functions ===		=== Named Objects Library : other miscellaneous functions ===

Pguy: /* Named Objects Library : How to retrieve the cached objects */

2018-12-28T14:51:15Z

Named Objects Library : How to retrieve the cached objects

← Older revision		Revision as of 14:51, 28 December 2018
Line 198:		Line 198:

	. . .		. . .
	~~NameObjectInfo~~[] itInfos = nochelper.GetNamedObjects(nochelper.NOC_ITS) ;		NamedObjectInfo[] itInfos = nochelper.GetNamedObjects(nochelper.NOC_ITS) ;
	if (itInfos.size())		if (itInfos.size())
	for (I=0;i<itInfos.size();I++)		for (I=0;i<itInfos.size();I++)

Pguy: /* Named Objects Library : How to register the objects type you want to be cached by the library */

2018-12-28T14:50:11Z

Named Objects Library : How to register the objects type you want to be cached by the library

← Older revision		Revision as of 14:50, 28 December 2018
Line 149:		Line 149:
	. . .		. . .
	}		}
	AddNamedObjectsTypeToCache(nochelper.NOC_ITS) ;		nochelper.AddNamedObjectsTypeToCache(nochelper.NOC_ITS) ;
	AddNamedObjectsTypeToCache(nochelper.NOC_CONSIST) ;		nochelper.AddNamedObjectsTypeToCache(nochelper.NOC_CONSIST) ;
	}		}

Vincentrh: Introduction of an example of application

2018-10-24T07:51:31Z

Introduction of an example of application

← Older revision		Revision as of 07:51, 24 October 2018
Line 283:		Line 283:
	public string GetPlatformsTrack(string sVirtualPlatformName) ; can be called to retrieve the real track name for a virtual platform name. Needs NOC_STATION to be currently loaded		public string GetPlatformsTrack(string sVirtualPlatformName) ; can be called to retrieve the real track name for a virtual platform name. Needs NOC_STATION to be currently loaded
	This primitive is needed for DriveToStation driver command.		This primitive is needed for DriveToStation driver command.

			=== Named Objects Library : example application ===

			To download on the DLS : 'Named Objects Library test' <kuid:458053:102778>.
			A simple object to put anywhere on a route ; its only purpose is to count the triggers on the 'world', as an illustration of the possibilities of the tool 'Named Objects Library'.
			You can edit its script and discover how some of the codes exposed above may be implemented.

			Please note : the script displays a list of triggers (if any on the route) ; this list may be consulted at the bottom left of the screen, in Driver Mode only.

	[[Category:Help\|Named Objects Library]]		[[Category:Help\|Named Objects Library]]

Pguy: /* Named Objects Library : How to register the objects type you want to be cached by the library */

2018-10-19T05:46:01Z

Named Objects Library : How to register the objects type you want to be cached by the library

← Older revision		Revision as of 05:46, 19 October 2018
Line 101:		Line 101:
	public define int NOC_STATION = 8192 ; // for passenger stations		public define int NOC_STATION = 8192 ; // for passenger stations
	public define int NOC_PORTAL = 16384 ; // for portals		public define int NOC_PORTAL = 16384 ; // for portals
			public define int NOC_SCENERY = 32768 ; // for any scenery object
			public define int NOC_TRC = 32769 ; // for #TRC objects


	A cache in the library is defined by its objects type integer value and by a searchFilter string. After being refreshed, a cache will contain an array of NamedObjectInfo objects containing all available objects matching the cache objects type and whose name begin by the search filter. If the search filter is empty (blank string) all the objects matching the cache objects type are returned.		A cache in the library is defined by its objects type integer value and by a searchFilter string. After being refreshed, a cache will contain an array of NamedObjectInfo objects containing all available objects matching the cache objects type and whose name begin by the search filter. If the search filter is empty (blank string) all the objects matching the cache objects type are returned.

Vincentrh at 08:32, 16 October 2018

2018-10-16T08:32:45Z

← Older revision		Revision as of 08:32, 16 October 2018
Line 240:		Line 240:
	=== Named Objects Library : alternative RetrieveNamedObjects API ===		=== Named Objects Library : alternative RetrieveNamedObjects API ===

	The above API is fine for regular recurrent request to retrieve available named objects and using cache techniques it enables to optimize scripts by sharing data between multiple assets and ~~to offer~~ synchronous answers to requests that have been pre fetched asynchronously.		The above API is fine for regular recurrent request to retrieve available named objects, and using cache techniques enables to optimize scripts by sharing data between multiple assets and offers synchronous answers to requests that have been pre fetched asynchronously.