Variable

/**
* @brief A properties entry variable.
*/

Inherit from VariableDO

Primary key: element_oid: int

schema Variable extends VariableDO {
  @primary element_oid: int,
  parent_oid: int,
  start_index: int,
  name: string,
  printable_text: string
}

Variable::getPrintableText

/**
* @brief gets the printable text of this element.
* @return string
*/
  • Parameter self: Variable
  • Return string
pub fn getPrintableText(self: Variable) -> string;

Variable::getParentOid

/**
* @brief gets the parent oid of this element.
* @return int
*/
pub fn getParentOid(self: Variable) -> int;

Variable::getBelongedEntry

/**
* @brief gets the belonged entry element of the element
* @return Entry 
*/
pub fn getBelongedEntry(self: Variable) -> Entry;

Variable::__all__

Data constraint method.

pub fn __all__(db: PropertiesDB) -> *Variable;

Variable::getLengthOfPrintableText

/**
* @brief gets the length of the variable's original text
* @return Entry 
*/
pub fn getLengthOfPrintableText(self: Variable) -> int;

Variable::getName

/**
* @brief gets the name of this element.
* @return string
*/
  • Parameter self: Variable
  • Return string
pub fn getName(self: Variable) -> string;

Variable::getStartIndex

/**
* @brief gets the start index of this element.
* @return int
*/
pub fn getStartIndex(self: Variable) -> int;

Variable::getLocation

/**
* @brief gets the location for the element.
* @return Location
*/
pub fn getLocation(self: Variable) -> Location;