Reference Source

js/nodes/node_feature.js

  1.  
  2.  
  3. // let context = 'server/nodes/node_feature'
  4.  
  5.  
  6.  
  7. /**
  8.  * @file Node feature: append a feature to a Node instance.
  9.  * @author Luc BORIES
  10.  * @license Apache-2.0
  11.  */
  12. export default class NodeFeature
  13. {
  14. 	/**
  15. 	 * Create a Nodefeature instance.
  16. 	 * @abstract
  17. 	 * 
  18. 	 * @param {Node} arg_node - node instance.
  19. 	 * @param {string} arg_name - feature name.
  20. 	 * 
  21. 	 * @returns {nothing}
  22. 	 */
  23. 	constructor(arg_node, arg_name)
  24. 	{
  25. 		/**
  26. 		 * Class type flag.
  27. 		 * @type {boolean}
  28. 		 */
  29. 		this.is_node_feature = true
  30. 		
  31. 		/**
  32. 		 * Node instance.
  33. 		 * @type {Node}
  34. 		 */
  35. 		this.node = arg_node
  36. 		
  37. 		/**
  38. 		 * Feature name.
  39. 		 * @type {string}
  40. 		 */
  41. 		this.name = arg_name
  42. 		
  43. 		/**
  44. 		 * Is ready flag.
  45. 		 * @type {boolean}
  46. 		 */
  47. 		this.is_ready = false
  48. 	}
  49.  
  50.  
  51.  
  52. 	/**
  53. 	 * Get feature name.
  54. 	 * 
  55. 	 * @returns {string} - feature name
  56. 	 */
  57. 	get_name()
  58. 	{
  59. 		return this.name
  60. 	}
  61.  
  62. 	
  63. 	
  64. 	/**
  65. 	 * Load Node settings.
  66. 	 * @abstract
  67. 	 * 
  68. 	 * @returns {nothing}
  69. 	 */
  70. 	load()
  71. 	{
  72. 		this.node.enter_group(':NodeFeature.load()')
  73. 		
  74. 		
  75. 		this.node.leave_group(':NodeFeature.load()')
  76. 	}
  77. 	
  78. 	
  79. 	
  80. 	/**
  81. 	 * Starts node feature.
  82. 	 * @abstract
  83. 	 * 
  84. 	 * @returns {nothing}
  85. 	 */
  86. 	start()
  87. 	{
  88. 		this.node.enter_group(':NodeFeature.start')
  89.  
  90. 		
  91. 		this.node.leave_group(':NodeFeature.start')
  92. 	}
  93. 	
  94. 	
  95. 	
  96. 	/**
  97. 	 * Stops node feature.
  98. 	 * @abstract
  99. 	 * 
  100. 	 * @returns {nothing}
  101. 	 */
  102. 	stop()
  103. 	{
  104. 		this.node.enter_group(':NodeFeature.stop')
  105. 		
  106. 		
  107. 		this.node.leave_group(':NodeFeature.stop')
  108. 	}
  109. }