WhileStatement
/**
* @brief A while loop statement.
*/
Inherit from Statement
Primary key: element_oid: int
schema WhileStatement extends Statement {
@primary element_oid: int,
type: string,
element_index: int,
parent_oid: int,
location_oid: int,
printable_text: string
}
WhileStatement::getLocationOid
/**
* @brief gets the location oid of this element.
* @return int
*/
- Parameter
self
:WhileStatement
- Return
int
pub fn getLocationOid(self: WhileStatement) -> int;
WhileStatement::getParent
/**
* @brief gets the parent element of the statement
* @return CombineElement
*/
- Parameter
self
:WhileStatement
- Return
CombineElement
pub fn getParent(self: WhileStatement) -> CombineElement;
WhileStatement::getElementIndex
/**
* @brief gets the element index of this element.
* @return int
*/
- Parameter
self
:WhileStatement
- Return
int
pub fn getElementIndex(self: WhileStatement) -> int;
WhileStatement::getParentOid
/**
* @brief gets the parent oid of this element.
* @return int
*/
- Parameter
self
:WhileStatement
- Return
int
pub fn getParentOid(self: WhileStatement) -> int;
WhileStatement::getEnclosingStatement
/**
* @brief gets the statement containing this statement.
* @return Statement
*/
- Parameter
self
:WhileStatement
- Return
Statement
pub fn getEnclosingStatement(self: WhileStatement) -> Statement;
WhileStatement::getAnAncestor
/**
* @brief gets an ancestor of the element.
* @return CombineElement
*/
- Parameter
self
:WhileStatement
- Return
*CombineElement
pub fn getAnAncestor(self: WhileStatement) -> *CombineElement;
WhileStatement::getPrintableText
/**
* @brief gets the printable text of this element.
* @return string
*/
- Parameter
self
:WhileStatement
- Return
string
pub fn getPrintableText(self: WhileStatement) -> string;
WhileStatement::getLocation
/**
* @brief gets the location for the element.
* @return Location
*/
- Parameter
self
:WhileStatement
- Return
Location
pub fn getLocation(self: WhileStatement) -> Location;
WhileStatement::__all__
Data constraint method.
- Parameter
db
:PythonDB
- Return
*WhileStatement
pub fn __all__(db: PythonDB) -> *WhileStatement;
WhileStatement::getType
/**
* @brief gets the type of this element.
* @return string
*/
- Parameter
self
:WhileStatement
- Return
string
pub fn getType(self: WhileStatement) -> string;
WhileStatement::getEnclosingScope
/**
* @brief gets the immediately enclosing scope (module, function or class) whose body contains this statement.
* @return Scope
*/
- Parameter
self
:WhileStatement
- Return
Scope
pub fn getEnclosingScope(self: WhileStatement) -> Scope;
WhileStatement::getSize
/**
* @brief gets the size information for the element.
* @return NumberOfLines
*/
- Parameter
self
:WhileStatement
- Return
NumberOfLines
pub fn getSize(self: WhileStatement) -> NumberOfLines;
WhileStatement::getAChild
/**
* @brief gets a child of this statement.
* @return Statement
*/
- Parameter
self
:WhileStatement
- Return
*Statement
pub fn getAChild(self: WhileStatement) -> *Statement;