hgl::_IndexData< F, T, data_struct >模板类参考

#include <IndexData.H>

继承图，类hgl::_IndexData< F, T, data_struct >

所有成员的列表。

公有类型
typedef data_struct	DataStruct
公有成员
	_IndexData ()
virtual	~_IndexData ()
DataStruct *	Add (const F &, const T &)
	添加一个数据
T &	Add (const F &)
	添加一个数据
void	Add (DataStruct *)
	添加一个数据
int	Find (const F &) const
	查找数据是否存在
int	FindByData (const T &) const
	查找数据是否存在
virtual bool	Get (const F &, T &) const
	取得数据
virtual void	Set (const F &, T &)
	设置数据(如不存在则创建)
virtual bool	Unlink (const F &, T &)
	将指定数据从列表中移除，但并不删除这个数据
virtual bool	UnlinkByIndex (const F &)
	根据索引将指定数据从列表中移除，但并不删除这个数据
virtual bool	UnlinkByData (const T &)
	根据数据将指定数据从列表中移除，但并不删除这个数据
virtual bool	UnlinkBySerial (int)
	根据序号将指定数据从列表中移除，但并不删除这个数据
virtual void	UnlinkAll ()
	将所有数据从列表中移除，但并不删除数据
virtual bool	DeleteByIndex (const F &)
	删除一个数据(按索引)
virtual bool	DeleteByData (T &)
	删除一个数据(按数据)
virtual bool	DeleteBySerial (int)
	删除一个数据(按序号)
virtual void	DeleteAll ()
	删除所有数据
virtual bool	Change (const F &, T &)
	更改一个数据的内容(如不存在则更改失效)
virtual void	Clear ()
	清除所有数据
DataStruct *	GetItem (int n) const
	取指定序号的数据
bool	Get (int, F &, T &) const
	取指定序号的数据
bool	GetIndex (int, F &) const
	取指定序号的索引
bool	GetData (int, T &) const
	取指定序号的数据
bool	SaveToStream (Stream *) const
	保存到流
bool	LoadFromStream (Stream *)
	从流加载
bool	SaveToFile (const wchar_t *) const
	保存到文件
bool	LoadFromFile (const wchar_t *)
	从文件加载
void	operator= (const _IndexData< F, T, DataStruct > &)
	操作符重载，复制一个列表
公有属性
Property< int >	Count
	数据个数
bool(*	OnSaveToStream )(Stream *, const F &, T &)
	保存到流事件
bool(*	OnLoadFromStream )(Stream *, F &, T &)
	从流加载事件
保护类型
typedef _IndexData< F, T, DataStruct >	this_calss
保护成员
int	FindPos (const F &) const
int	GetCount ()
	取得数据总量
保护属性
ObjectList< DataStruct >	data_list

---

详细描述

template<typename F, typename T, typename data_struct>
class hgl::_IndexData< F, T, data_struct >

索引数据模板

---

成员类型定义文档

template<typename F, typename T, typename data_struct>

typedef data_struct hgl::_IndexData< F, T, data_struct >::DataStruct

template<typename F, typename T, typename data_struct>

typedef _IndexData<F,T,DataStruct> hgl::_IndexData< F, T, data_struct >::this_calss [protected]

---

构造及析构函数文档

template<typename F , typename T , typename DataStruct >

hgl::_IndexData< F, T, DataStruct >::_IndexData

(

)

template<typename F, typename T, typename data_struct>

virtual hgl::_IndexData< F, T, data_struct >::~_IndexData

(

)

[inline, virtual]

---

成员函数文档

template<typename F, typename T, typename DataStruct >

DataStruct * hgl::_IndexData< F, T, DataStruct >::Add	(	const F &	flag,
		const T &	data
	)

添加一个数据

添加一个数据

参数:

flag	数据标识
data	数据

返回:

新创建好的数据结构

template<typename F, typename T, typename DataStruct >

T & hgl::_IndexData< F, T, DataStruct >::Add

(

const F &

flag

)

添加一个数据

添加一个数据

参数:

flag

数据标识

返回:

创建好的数据

template<typename F, typename T, typename DataStruct >

void hgl::_IndexData< F, T, DataStruct >::Add

(

DataStruct *

obj

)

添加一个数据

添加一个数据

参数:

obj

数据

template<typename F, typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::Change	(	const F &	flag,
		T &	data
	)		[virtual]

更改一个数据的内容(如不存在则更改失效)

更改数据,这个更改和Set不同,它要求指定标识的数据必须存在，则否就会更改失败

参数:

flag	数据标识
data	新的数据内容
return	是否更改成功

template<typename F , typename T , typename DataStruct >

void hgl::_IndexData< F, T, DataStruct >::Clear

(

)

[virtual]

清除所有数据

被hgl::_IndexObject< F, T, data_struct >、hgl::_IndexObject< WideString, DevilFunc, IndexFlagData< WideString, DevilFunc * > >、hgl::_IndexObject< WideString, DevilValueInterface, IndexFlagData< WideString, DevilValueInterface * > >、hgl::_IndexObject< WideString, DevilPropertyMap, IndexFlagData< WideString, DevilPropertyMap * > >、hgl::_IndexObject< WideString, DevilEnum, IndexFlagData< WideString, DevilEnum * > >、hgl::_IndexObject< WideString, AffectorObject, IndexFlagData< WideString, AffectorObject * > >、hgl::_IndexObject< WideString, Field, IndexFlagData< WideString, Field * > >、hgl::_IndexObject< wchar_t, Texture2D, IndexFlagData< wchar_t, Texture2D * > >、hgl::_IndexObject< WideString, DevilFuncMap, IndexFlagData< WideString, DevilFuncMap * > >及hgl::_IndexObject< F, T, IndexFlagData< F, T * > >重载。

template<typename F , typename T , typename DataStruct >

void hgl::_IndexData< F, T, DataStruct >::DeleteAll

(

)

[virtual]

删除所有数据

被hgl::_IndexObject< F, T, data_struct >、hgl::_IndexObject< WideString, DevilFunc, IndexFlagData< WideString, DevilFunc * > >、hgl::_IndexObject< WideString, DevilValueInterface, IndexFlagData< WideString, DevilValueInterface * > >、hgl::_IndexObject< WideString, DevilPropertyMap, IndexFlagData< WideString, DevilPropertyMap * > >、hgl::_IndexObject< WideString, DevilEnum, IndexFlagData< WideString, DevilEnum * > >、hgl::_IndexObject< WideString, AffectorObject, IndexFlagData< WideString, AffectorObject * > >、hgl::_IndexObject< WideString, Field, IndexFlagData< WideString, Field * > >、hgl::_IndexObject< wchar_t, Texture2D, IndexFlagData< wchar_t, Texture2D * > >、hgl::_IndexObject< WideString, DevilFuncMap, IndexFlagData< WideString, DevilFuncMap * > >及hgl::_IndexObject< F, T, IndexFlagData< F, T * > >重载。

template<typename F , typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::DeleteByData

(

T &

tp

)

[virtual]

删除一个数据(按数据)

删除一个数据

参数:

tp

要删除的数据

返回:

是否删除成功

template<typename F, typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::DeleteByIndex

(

const F &

flag

)

[virtual]

删除一个数据(按索引)

删除一个数据

参数:

flag

要删除的数据标识

返回:

是否删除成功

被hgl::_IndexObject< F, T, data_struct >及hgl::_IndexObject< F, T, IndexFlagData< F, T * > >重载。

template<typename F , typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::DeleteBySerial

(

int

index

)

[virtual]

删除一个数据(按序号)

删除一个数据

参数:

index

要删除的数据索引

返回:

是否删除成功

被hgl::_IndexObject< F, T, data_struct >、hgl::_IndexObject< WideString, DevilFunc, IndexFlagData< WideString, DevilFunc * > >、hgl::_IndexObject< WideString, DevilValueInterface, IndexFlagData< WideString, DevilValueInterface * > >、hgl::_IndexObject< WideString, DevilPropertyMap, IndexFlagData< WideString, DevilPropertyMap * > >、hgl::_IndexObject< WideString, DevilEnum, IndexFlagData< WideString, DevilEnum * > >、hgl::_IndexObject< WideString, AffectorObject, IndexFlagData< WideString, AffectorObject * > >、hgl::_IndexObject< WideString, Field, IndexFlagData< WideString, Field * > >、hgl::_IndexObject< wchar_t, Texture2D, IndexFlagData< wchar_t, Texture2D * > >、hgl::_IndexObject< WideString, DevilFuncMap, IndexFlagData< WideString, DevilFuncMap * > >及hgl::_IndexObject< F, T, IndexFlagData< F, T * > >重载。

template<typename F, typename T , typename DataStruct >

int hgl::_IndexData< F, T, DataStruct >::Find

(

const F &

flag

)

const

查找数据是否存在

查找数据是否存在

参数:

flag

数据标识

返回:

数据所在索引，-1表示不存在

template<typename F , typename T, typename DataStruct >

int hgl::_IndexData< F, T, DataStruct >::FindByData

(

const T &

data

)

const

查找数据是否存在

template<typename F, typename T , typename DataStruct >

int hgl::_IndexData< F, T, DataStruct >::FindPos

(

const F &

flag

)

const [protected]

template<typename F, typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::Get	(	const F &	flag,
		T &	data
	)		const [virtual]

取得数据

根据索引取得数据

参数:

flag	数据索引
data	数据存放处

返回:

是否取得成功

template<typename F, typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::Get	(	int	index,
		F &	f,
		T &	t
	)		const

取指定序号的数据

根据序号取得数据

参数:

index	序号
f	数据索引存放处
t	数据存放处

返回:

是否取得成功

template<typename F, typename T, typename data_struct>

int hgl::_IndexData< F, T, data_struct >::GetCount

(

)

[inline, protected]

取得数据总量

template<typename F , typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::GetData	(	int	index,
		T &	t
	)		const

取指定序号的数据

根据序号取得数据

参数:

index	序号
t	数据存放处

返回:

是否取得成功

template<typename F, typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::GetIndex	(	int	index,
		F &	f
	)		const

取指定序号的索引

根据序号取得索引

参数:

index	序号
f	数据索引存放处

返回:

是否取得成功

template<typename F, typename T, typename data_struct>

DataStruct* hgl::_IndexData< F, T, data_struct >::GetItem

(

int

n

)

const [inline]

取指定序号的数据

template<typename F , typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::LoadFromFile

(

const wchar_t *

filename

)

从文件加载

从流中加载整个列表

参数:

str

要加载的文件

返回:

是否加载成功

template<typename F , typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::LoadFromStream

(

Stream *

str

)

从流加载

从流中加载整个列表

参数:

str

要加载的流

返回:

是否加载成功

template<typename F, typename T, typename DataStruct >

void hgl::_IndexData< F, T, DataStruct >::operator=

(

const _IndexData< F, T, DataStruct > &

ftd

)

操作符重载，复制一个列表

template<typename F , typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::SaveToFile

(

const wchar_t *

filename

)

const

保存到文件

保存整个列表到文件中

参数:

filename

要保存的文件名

返回:

是否保存成功

template<typename F , typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::SaveToStream

(

Stream *

str

)

const

保存到流

保存整个列表到流中

参数:

str

要保存的流

返回:

是否保存成功

template<typename F, typename T, typename DataStruct >

void hgl::_IndexData< F, T, DataStruct >::Set	(	const F &	flag,
		T &	data
	)		[virtual]

设置数据(如不存在则创建)

设置数据,如果指定标识的数据不存在，则创建数据

参数:

flag	数据标识
data	数据

template<typename F, typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::Unlink	(	const F &	flag,
		T &	data
	)		[virtual]

将指定数据从列表中移除，但并不删除这个数据

将指定数据从列表中移除同时取得这个数据，但并不删除它

参数:

flag	数据标识
data	数据存放位处

返回:

是否成功

template<typename F , typename T , typename DataStruct >

void hgl::_IndexData< F, T, DataStruct >::UnlinkAll

(

)

[virtual]

将所有数据从列表中移除，但并不删除数据

template<typename F , typename T, typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::UnlinkByData

(

const T &

data

)

[virtual]

根据数据将指定数据从列表中移除，但并不删除这个数据

根据数据将指定数据从列表中移除同时取得这个数据，但并不删除它

参数:

data

数据

返回:

是否成功

template<typename F, typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::UnlinkByIndex

(

const F &

flag

)

[virtual]

根据索引将指定数据从列表中移除，但并不删除这个数据

根据索引将指定数据从列表中移除同时取得这个数据，但并不删除它

参数:

flag

索引

返回:

是否成功

template<typename F , typename T , typename DataStruct >

bool hgl::_IndexData< F, T, DataStruct >::UnlinkBySerial

(

int

index

)

[virtual]

根据序号将指定数据从列表中移除，但并不删除这个数据

根据序号将指定数据从列表中移除同时取得这个数据，但并不删除它

参数:

index

序号

返回:

是否成功

---

成员数据文档

template<typename F, typename T, typename data_struct>

Property<int> hgl::_IndexData< F, T, data_struct >::Count

数据个数

template<typename F, typename T, typename data_struct>

ObjectList<DataStruct> hgl::_IndexData< F, T, data_struct >::data_list [protected]

template<typename F, typename T, typename data_struct>

bool(* hgl::_IndexData< F, T, data_struct >::OnLoadFromStream)(Stream *, F &, T &)

从流加载事件

template<typename F, typename T, typename data_struct>

bool(* hgl::_IndexData< F, T, data_struct >::OnSaveToStream)(Stream *, const F &, T &)

保存到流事件

---

该类的文档由以下文件生成：

• K:/CMGDKv18/SDK/Include/hgl/type/IndexData.H
• K:/CMGDKv18/SDK/Include/hgl/type/IndexData.CPP