/**
* A Stackable interface
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
function pushNamed ($stackerName, $value);
/**
- * 'Pops' a value from a named stacker
+ * 'Pops' a value from a named stacker and returns it's value
*
* @param $stackerName Name of the stacker
- * @return void
+ * @return $value Value of the current stack entry
* @throws NoStackerException If the named stacker was not found
* @throws EmptyStackerException If the named stacker is empty
*/
function popNamed ($stackerName);
/**
- * Get value from named stacker
+ * Get value from named stacker but don't "pop" it
*
* @param $stackerName Name of the stacker
* @return $value Value of last added value
* @throws EmptyStackerException If the named stacker is empty
*/
function getNamed ($stackerName);
+
+ /**
+ * Checks whether the given stack is initialized (set in array $stackers)
+ *
+ * @param $stackerName Name of the stack
+ * @return $isInitialized Whether the stack is initialized
+ */
+ function isStackInitialized ($stackerName);
+
+ /**
+ * Checks whether the given stack is empty
+ *
+ * @param $stackerName Name of the stack
+ * @return $isEmpty Whether the stack is empty
+ * @throws NoStackerException If given stack is missing
+ */
+ function isStackEmpty ($stackerName);
}
// [EOF]