Class

/**
* @brief A python class, which is a class def statement.
*/

Inherit from ClassDefStatement

Primary key: element_oid: int

schema Class extends ClassDefStatement {
  @primary element_oid: int,
  type: string,
  element_index: int,
  parent_oid: int,
  location_oid: int,
  printable_text: string
}

Class::getAnAncestor

/**
* @brief gets an ancestor of the element.
* @return CombineElement 
*/
pub fn getAnAncestor(self: Class) -> *CombineElement;

Class::getType

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

Class::getEnclosingStatement

/**
* @brief gets the statement containing this statement.
* @return Statement 
*/
pub fn getEnclosingStatement(self: Class) -> Statement;

Class::getElementIndex

/**
* @brief gets the element index of this element.
* @return int
*/
  • Parameter self: Class
  • Return int
pub fn getElementIndex(self: Class) -> int;

Class::getAChild

/**
* @brief gets a child of this statement.
* @return Statement 
*/
pub fn getAChild(self: Class) -> *Statement;

Class::getDecorator

/**
* @brief gets the decorator of the class, if any.
* @return Decorator
*/
pub fn getDecorator(self: Class) -> *Decorator;

Class::getInitFunction

/**
* @brief gets the init function for the class, if any.
* @return Function
*/
pub fn getInitFunction(self: Class) -> InitFunction;

Class::getSize

/**
* @brief gets the size information for the element.
* @return NumberOfLines
*/
pub fn getSize(self: Class) -> NumberOfLines;

Class::getEnclosingScope

/**
* @brief gets the immediately enclosing scope (module, function or class) whose body contains this statement.
* @return Scope 
*/
pub fn getEnclosingScope(self: Class) -> Scope;

Class::getBase

/**
* @brief gets the base expression of the class, if any.
* @return Expression
*/
pub fn getBase(self: Class) -> *Expression;

Class::getAFunction

/**
* @brief gets the function defined in the class, if any.
* @return Function
*/
pub fn getAFunction(self: Class) -> *Function;

Class::getLocation

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

Class::getPrintableText

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

Class::__all__

Data constraint method.

pub fn __all__(db: PythonDB) -> *Class;

Class::getParentOid

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

Class::getAnAncestorInheritedClass

/**
* @brief gets an ancestor inherited class of the class, if any.
* @return Class
*/
pub fn getAnAncestorInheritedClass(self: Class) -> *Class;

Class::getQualifiedName

/**
* @brief gets the qualified name of the class.
* @return string
*/
  • Parameter self: Class
  • Return string
pub fn getQualifiedName(self: Class) -> string;

Class::getName

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

Class::getBaseName

/**
* @brief gets the base name of the class, if any.
* @return string
*/
  • Parameter self: Class
  • Return *string
pub fn getBaseName(self: Class) -> *string;

Class::getInheritedClass

/**
* @brief gets the inherited class of the class, if any.
* @return Class
*/
pub fn getInheritedClass(self: Class) -> Class;

Class::getLocationOid

/**
* @brief gets the location oid of this element.
* @return int
*/
  • Parameter self: Class
  • Return int
pub fn getLocationOid(self: Class) -> int;

Class::getParent

/**
* @brief gets the parent element of the statement
* @return CombineElement 
*/
pub fn getParent(self: Class) -> CombineElement;