IDataNode.cs 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. //------------------------------------------------------------
  2. // Game Framework
  3. // Copyright © 2013-2021 loyalsoft. All rights reserved.
  4. // Homepage: http://www.game7000.com/
  5. // Feedback: http://www.game7000.com/
  6. //------------------------------------------------------------
  7. using System.Collections.Generic;
  8. namespace GameFramework.DataNode
  9. {
  10. /// <summary>
  11. /// 数据结点接口。
  12. /// </summary>
  13. public interface IDataNode
  14. {
  15. /// <summary>
  16. /// 获取数据结点的名称。
  17. /// </summary>
  18. string Name
  19. {
  20. get;
  21. }
  22. /// <summary>
  23. /// 获取数据结点的完整名称。
  24. /// </summary>
  25. string FullName
  26. {
  27. get;
  28. }
  29. /// <summary>
  30. /// 获取父数据结点。
  31. /// </summary>
  32. IDataNode Parent
  33. {
  34. get;
  35. }
  36. /// <summary>
  37. /// 获取子数据结点的数量。
  38. /// </summary>
  39. int ChildCount
  40. {
  41. get;
  42. }
  43. /// <summary>
  44. /// 根据类型获取数据结点的数据。
  45. /// </summary>
  46. /// <typeparam name="T">要获取的数据类型。</typeparam>
  47. /// <returns>指定类型的数据。</returns>
  48. T GetData<T>() where T : Variable;
  49. /// <summary>
  50. /// 获取数据结点的数据。
  51. /// </summary>
  52. /// <returns>数据结点数据。</returns>
  53. Variable GetData();
  54. /// <summary>
  55. /// 设置数据结点的数据。
  56. /// </summary>
  57. /// <typeparam name="T">要设置的数据类型。</typeparam>
  58. /// <param name="data">要设置的数据。</param>
  59. void SetData<T>(T data) where T : Variable;
  60. /// <summary>
  61. /// 设置数据结点的数据。
  62. /// </summary>
  63. /// <param name="data">要设置的数据。</param>
  64. void SetData(Variable data);
  65. /// <summary>
  66. /// 根据索引检查是否存在子数据结点。
  67. /// </summary>
  68. /// <param name="index">子数据结点的索引。</param>
  69. /// <returns>是否存在子数据结点。</returns>
  70. bool HasChild(int index);
  71. /// <summary>
  72. /// 根据名称检查是否存在子数据结点。
  73. /// </summary>
  74. /// <param name="name">子数据结点名称。</param>
  75. /// <returns>是否存在子数据结点。</returns>
  76. bool HasChild(string name);
  77. /// <summary>
  78. /// 根据索引获取子数据结点。
  79. /// </summary>
  80. /// <param name="index">子数据结点的索引。</param>
  81. /// <returns>指定索引的子数据结点,如果索引越界,则返回空。</returns>
  82. IDataNode GetChild(int index);
  83. /// <summary>
  84. /// 根据名称获取子数据结点。
  85. /// </summary>
  86. /// <param name="name">子数据结点名称。</param>
  87. /// <returns>指定名称的子数据结点,如果没有找到,则返回空。</returns>
  88. IDataNode GetChild(string name);
  89. /// <summary>
  90. /// 根据名称获取或增加子数据结点。
  91. /// </summary>
  92. /// <param name="name">子数据结点名称。</param>
  93. /// <returns>指定名称的子数据结点,如果对应名称的子数据结点已存在,则返回已存在的子数据结点,否则增加子数据结点。</returns>
  94. IDataNode GetOrAddChild(string name);
  95. /// <summary>
  96. /// 获取所有子数据结点。
  97. /// </summary>
  98. /// <returns>所有子数据结点。</returns>
  99. IDataNode[] GetAllChild();
  100. /// <summary>
  101. /// 获取所有子数据结点。
  102. /// </summary>
  103. /// <param name="results">所有子数据结点。</param>
  104. void GetAllChild(List<IDataNode> results);
  105. /// <summary>
  106. /// 根据索引移除子数据结点。
  107. /// </summary>
  108. /// <param name="index">子数据结点的索引。</param>
  109. void RemoveChild(int index);
  110. /// <summary>
  111. /// 根据名称移除子数据结点。
  112. /// </summary>
  113. /// <param name="name">子数据结点名称。</param>
  114. void RemoveChild(string name);
  115. /// <summary>
  116. /// 移除当前数据结点的数据和所有子数据结点。
  117. /// </summary>
  118. void Clear();
  119. /// <summary>
  120. /// 获取数据结点字符串。
  121. /// </summary>
  122. /// <returns>数据结点字符串。</returns>
  123. string ToString();
  124. /// <summary>
  125. /// 获取数据字符串。
  126. /// </summary>
  127. /// <returns>数据字符串。</returns>
  128. string ToDataString();
  129. }
  130. }