TFPSMap class

In unit fgl

Basic map object, used in generic maps.

Declaration

pascal

TFPSMap = class(TFPSList)

Inheritance

TFPSMap
TFPSList
TObject

Descends from it: TFPGMap TFPGMapInterfacedObjectData TFPGMapObject

Description

TFPSMap can be used to create a map for any type T that does not require reference counting (such as interfaced objects). It will specialize to a map which is a generalized list with an arbitrary type as the list index (called the key).

This class should normally not be used directly, instead use one of the generic map objects such as TFPGMap.

Properties

`Duplicates`	public	What to do with duplicate key values.
`KeySize`	public	Size (in bytes) for the key.
`DataSize`	public	Size (in bytes) for the data associated with keys.
`Keys`	public	Indexed access to the locations of all keys.
`Data`	public	Indexed access to the locations of all data items.
`KeyData`	public	Access to data locations using key.
`Sorted`	public	Is the map permanently sorted on key ?

Methods

`BinaryCompareKey`	protected
`BinaryCompareData`	protected
`SetOnKeyPtrCompare`	protected
`SetOnDataPtrCompare`	protected
`InitOnPtrCompare`	protected
`CopyKey`	protected
`CopyData`	protected
`GetKey`	protected
`GetKeyData`	protected
`GetData`	protected
`LinearIndexOf`	protected
`PutKey`	protected
`PutKeyData`	protected
`PutData`	protected
`Create`	public	Create a new map with given key and data size.
`Add`	public	Add a key, value pair to the map.
`Find`	public	Find data using the associated key.
`IndexOf`	public	Index of key pointed to by AKey.
`IndexOfData`	public	Index of data item AData.
`Insert`	public	Insert a new slot for key and associated data item in the list.
`InsertKey`	public	Insert a key in the list.
`InsertKeyData`	public	Insert a key and associated in the list.
`Remove`	public	Remove a key/value pair from the map.
`Sort`	public	Sort the list according to key.
`SortRange`	public

Events

`OnPtrCompare`	public	Alias for OnKeyPtrCompare.
`OnKeyPtrCompare`	public	Callback to compare 2 keys.
`OnDataPtrCompare`	public	Callback to compare 2 data items.

Inherited

From TFPSList (39)

AddList Assign Capacity CheckIndex Clear CopyItem CopyItems Count Delete DeleteRange Deref Destroy Error Exchange Expand Extract First Get GetFirst GetLast InsertRange InternalExchange InternalGet InternalItems InternalPut ItemIsManaged Items ItemSize Last List Move Pack Put QuickSort RaiseIndexError SetCapacity SetCount SetFirst SetLast

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.