Mechatronics Portfolio
Logan Williamson's Mechatronics Portfolio and Documentation Repository
Public Member Functions | List of all members
shares.Share Class Reference

A standard shared variable. More...

Public Member Functions

def __init__ (self, initial_value=None)
 Constructs a shared variable. More...
 
def write (self, item)
 Updates the value of the shared variable. More...
 
def read (self)
 Access the value of the shared variable. More...
 
def __init__ (self, initial_value=None)
 Constructs a shared variable. More...
 
def write (self, item)
 Updates the value of the shared variable. More...
 
def read (self)
 Access the value of the shared variable. More...
 

Detailed Description

A standard shared variable.

Values can be accessed with read() or changed with write()

Constructor & Destructor Documentation

◆ __init__() [1/2]

def shares.Share.__init__ (   self,
  initial_value = None 
)

Constructs a shared variable.

Parameters
initial_valueAn optional initial value for the shared variable.

◆ __init__() [2/2]

def shares.Share.__init__ (   self,
  initial_value = None 
)

Constructs a shared variable.

Parameters
initial_valueAn optional initial value for the shared variable.

Member Function Documentation

◆ read() [1/2]

def shares.Share.read (   self)

Access the value of the shared variable.

Returns
The value of the shared variable

◆ read() [2/2]

def shares.Share.read (   self)

Access the value of the shared variable.

Returns
The value of the shared variable

◆ write() [1/2]

def shares.Share.write (   self,
  item 
)

Updates the value of the shared variable.

Parameters
itemThe new value for the shared variable

◆ write() [2/2]

def shares.Share.write (   self,
  item 
)

Updates the value of the shared variable.

Parameters
itemThe new value for the shared variable

The documentation for this class was generated from the following files: