Tronverte
API documentation for Tronverte products.
 All Classes Namespaces Files Functions Variables
Public Member Functions
tronverte.core.enum.Enum Class Reference

Inherited by tronverte.core.status.Code, tronverte.core.status.Level, and tronverte.core.status.Stat.

List of all members.

Public Member Functions

def __init__
def listMembers
def listMemberElements

Detailed Description

import tronverte.core.enum as tronverte_core_enum
reload(tronverte_core_enum)
enum = tronverte_core_enum.Enum()

Enum class has been provided to mimic enum data type in Python language. We often create dedicated classes to keep our settings as public static members.
When those classes driven by Enum class we can use "listMembers" method on them to get all members of the class at once without calling another method from another object.

Constructor & Destructor Documentation

# DESCRIPTION
Default constructor.

# ARGUMENTS
None.

# RETURN
None

Member Function Documentation

def tronverte.core.enum.Enum.listMemberElements (   cls,
  member 
)
# DESCRIPTION
List elements of a static public member of the class.

# ARGUMENTS
member | str | None | in | + | arg | Name of the member of the class

# RETURN
str list | Elements.
def tronverte.core.enum.Enum.listMembers (   cls,
  stringOnly = True,
  getValues = True 
)
# DESCRIPTION
List static public members of the class.

# ARGUMENTS
stringOnly | bool | True | in | * | arg | Get only string type of members.
getValues  | bool | True | in | * | arg | Get values of the members instead of the member names.

# RETURN
str list | Members.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables