erminas.SmartAPI.Utils.CachedCollections.IRDList< T > Interface Template Reference

A IIndexedCachedList for IRedDotObjects which provides convenience functions to get objects by guid and name. Those functions don't necessarily use an index, so if you need indexed access through guid, use the Guid as key in a IndexedCachedList{TK,T} . If you need indexed access through name, use NameIndexedRDList{T} More...

Inheritance diagram for erminas.SmartAPI.Utils.CachedCollections.IRDList< T >:

Collaboration diagram for erminas.SmartAPI.Utils.CachedCollections.IRDList< T >:

Public Member Functions
new IRDList< T >	Refreshed ()
void	WaitFor (Predicate< IRDList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)
	Same as WaitFor in ICachedList{T} but with an IRDList as predicate input. Provided for convenience.
Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IRDEnumerable< T >
bool	Contains (T element)
bool	ContainsGuid (Guid guid)
bool	ContainsName (string name)
T	GetByGuid (Guid guid)
T	GetByName (string name)
	Get the first element with Name == name
bool	TryGetByGuid (Guid guid, out T output)
bool	TryGetByName (string name, out T output)
	Try to get the first element with Name == name
Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.ICachedList< out T >
T	GetByPosition (int pos)
	Get an element of the list at a specific position.
ICachedList< T >	Refreshed ()
	Calls Refresh() and returns this.
void	WaitFor (Predicate< ICachedList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)
	Waits until a predicate on itself becomes true. Every retry period Refresh() is called and the predicate evaluated again, until the predicate evaluates to true, or the wait timespan is exhausted.

Properties
new int	Count [get]
Properties inherited from erminas.SmartAPI.Utils.CachedCollections.IRDEnumerable< T >
int	Count [get]
Properties inherited from erminas.SmartAPI.Utils.CachedCollections.ICachedList< out T >
int	Count [get]
bool	IsCachingEnabled [get, set]
	True == caching is enabled False == caching is disabled

Detailed Description

A IIndexedCachedList for IRedDotObjects which provides convenience functions to get objects by guid and name. Those functions don't necessarily use an index, so if you need indexed access through guid, use the Guid as key in a IndexedCachedList{TK,T} . If you need indexed access through name, use NameIndexedRDList{T}

Template Parameters

T

Type Constraints

T	:	class
T	:	IRedDotObject

Definition at line 28 of file IRDList.cs.

Member Function Documentation

new IRDList<T> erminas.SmartAPI.Utils.CachedCollections.IRDList< T >.Refreshed

(

)

void erminas.SmartAPI.Utils.CachedCollections.IRDList< T >.WaitFor	(	Predicate< IRDList< T >>	predicate,
		TimeSpan	wait,
		TimeSpan	retryPeriod
	)

Same as WaitFor in ICachedList{T} but with an IRDList as predicate input. Provided for convenience.

Property Documentation

new int erminas.SmartAPI.Utils.CachedCollections.IRDList< T >.Count

get

Definition at line 30 of file IRDList.cs.

---

The documentation for this interface was generated from the following file:

• IRDList.cs