agora.utils.example.ExampleClass

class agora.utils.example.ExampleClass(parameter: int)

Bases: object

This is an example class to show the structure.

Methods

add_n(n)	Adds n to the class instance's parameter.
add_one()	Takes the parameter and adds one.

__init__(parameter: int)

This class takes one parameter and is used to add one to that parameter.

Parameters

parameter – The parameter for this class

Methods

__init__(parameter)	This class takes one parameter and is used to add one to that parameter.
add_n(n)	Adds n to the class instance's parameter.
add_one()	Takes the parameter and adds one.

add_n(n: int)

Adds n to the class instance’s parameter.

For instance >>> x = ExampleClass(1) >>> x.add_n(10) 11

Parameters

n – The number to add

Returns

the parameter + n

add_one()

Takes the parameter and adds one.

>>> x = ExampleClass(1)
>>> x.add_one()
2

Returns

the parameter + 1