Module meshtastic.globals

Globals singleton class.

Instead of using a global, stuff your variables in this "trash can". This is not much better than using python's globals, but it allows us to better test meshtastic. Plus, there are some weird python global issues/gotcha that we can hopefully avoid by using this class instead.

"""Globals singleton class.

   Instead of using a global, stuff your variables in this "trash can".
   This is not much better than using python's globals, but it allows
   us to better test meshtastic. Plus, there are some weird python
   global issues/gotcha that we can hopefully avoid by using this
   class instead.

"""

class Globals:
    """Globals class is a Singleton."""
    __instance = None

    @staticmethod
    def getInstance():
        """Get an instance of the Globals class."""
        if Globals.__instance is None:
            Globals()
        return Globals.__instance

    def __init__(self):
        """Constructor for the Globals CLass"""
        if Globals.__instance is not None:
            raise Exception("This class is a singleton")
        else:
            Globals.__instance = self
        self.args = None
        self.parser = None
        self.channel_index = None
        self.logfile = None
        self.tunnelInstance = None
        # TODO: to migrate to camel_case for v1.3 change this value to True
        self.camel_case = False

    def reset(self):
        """Reset all of our globals. If you add a member, add it to this method, too."""
        self.args = None
        self.parser = None
        self.channel_index = None
        self.logfile = None
        self.tunnelInstance = None
        # TODO: to migrate to camel_case for v1.3 change this value to True
        self.camel_case = False

    # setters
    def set_args(self, args):
        """Set the args"""
        self.args = args

    def set_parser(self, parser):
        """Set the parser"""
        self.parser = parser

    def set_channel_index(self, channel_index):
        """Set the channel_index"""
        self.channel_index = channel_index

    def set_logfile(self, logfile):
        """Set the logfile"""
        self.logfile = logfile

    def set_tunnelInstance(self, tunnelInstance):
        """Set the tunnelInstance"""
        self.tunnelInstance = tunnelInstance

    def set_camel_case(self):
        """Force using camelCase for things like prefs/set/set"""
        self.camel_case = True

    # getters
    def get_args(self):
        """Get args"""
        return self.args

    def get_parser(self):
        """Get parser"""
        return self.parser

    def get_channel_index(self):
        """Get channel_index"""
        return self.channel_index

    def get_logfile(self):
        """Get logfile"""
        return self.logfile

    def get_tunnelInstance(self):
        """Get tunnelInstance"""
        return self.tunnelInstance

    def get_camel_case(self):
        """Get whether or not to use camelCase"""
        return self.camel_case

Classes

class Globals

Globals class is a Singleton.

Constructor for the Globals CLass

Expand source code

class Globals:
    """Globals class is a Singleton."""
    __instance = None

    @staticmethod
    def getInstance():
        """Get an instance of the Globals class."""
        if Globals.__instance is None:
            Globals()
        return Globals.__instance

    def __init__(self):
        """Constructor for the Globals CLass"""
        if Globals.__instance is not None:
            raise Exception("This class is a singleton")
        else:
            Globals.__instance = self
        self.args = None
        self.parser = None
        self.channel_index = None
        self.logfile = None
        self.tunnelInstance = None
        # TODO: to migrate to camel_case for v1.3 change this value to True
        self.camel_case = False

    def reset(self):
        """Reset all of our globals. If you add a member, add it to this method, too."""
        self.args = None
        self.parser = None
        self.channel_index = None
        self.logfile = None
        self.tunnelInstance = None
        # TODO: to migrate to camel_case for v1.3 change this value to True
        self.camel_case = False

    # setters
    def set_args(self, args):
        """Set the args"""
        self.args = args

    def set_parser(self, parser):
        """Set the parser"""
        self.parser = parser

    def set_channel_index(self, channel_index):
        """Set the channel_index"""
        self.channel_index = channel_index

    def set_logfile(self, logfile):
        """Set the logfile"""
        self.logfile = logfile

    def set_tunnelInstance(self, tunnelInstance):
        """Set the tunnelInstance"""
        self.tunnelInstance = tunnelInstance

    def set_camel_case(self):
        """Force using camelCase for things like prefs/set/set"""
        self.camel_case = True

    # getters
    def get_args(self):
        """Get args"""
        return self.args

    def get_parser(self):
        """Get parser"""
        return self.parser

    def get_channel_index(self):
        """Get channel_index"""
        return self.channel_index

    def get_logfile(self):
        """Get logfile"""
        return self.logfile

    def get_tunnelInstance(self):
        """Get tunnelInstance"""
        return self.tunnelInstance

    def get_camel_case(self):
        """Get whether or not to use camelCase"""
        return self.camel_case

Static methods

def getInstance()

Get an instance of the Globals class.

Expand source code

@staticmethod
def getInstance():
    """Get an instance of the Globals class."""
    if Globals.__instance is None:
        Globals()
    return Globals.__instance

Methods

def get_args(self)

Get args

Expand source code

def get_args(self):
    """Get args"""
    return self.args

def get_camel_case(self)

Get whether or not to use camelCase

Expand source code

def get_camel_case(self):
    """Get whether or not to use camelCase"""
    return self.camel_case

def get_channel_index(self)

Get channel_index

Expand source code

def get_channel_index(self):
    """Get channel_index"""
    return self.channel_index

def get_logfile(self)

Get logfile

Expand source code

def get_logfile(self):
    """Get logfile"""
    return self.logfile

def get_parser(self)

Get parser

Expand source code

def get_parser(self):
    """Get parser"""
    return self.parser

def get_tunnelInstance(self)

Get tunnelInstance

Expand source code

def get_tunnelInstance(self):
    """Get tunnelInstance"""
    return self.tunnelInstance

def reset(self)

Reset all of our globals. If you add a member, add it to this method, too.

Expand source code

def reset(self):
    """Reset all of our globals. If you add a member, add it to this method, too."""
    self.args = None
    self.parser = None
    self.channel_index = None
    self.logfile = None
    self.tunnelInstance = None
    # TODO: to migrate to camel_case for v1.3 change this value to True
    self.camel_case = False

def set_args(self, args)

Set the args

Expand source code

def set_args(self, args):
    """Set the args"""
    self.args = args

def set_camel_case(self)

Force using camelCase for things like prefs/set/set

Expand source code

def set_camel_case(self):
    """Force using camelCase for things like prefs/set/set"""
    self.camel_case = True

def set_channel_index(self, channel_index)

Set the channel_index

Expand source code

def set_channel_index(self, channel_index):
    """Set the channel_index"""
    self.channel_index = channel_index

def set_logfile(self, logfile)

Set the logfile

Expand source code

def set_logfile(self, logfile):
    """Set the logfile"""
    self.logfile = logfile

def set_parser(self, parser)

Set the parser

Expand source code

def set_parser(self, parser):
    """Set the parser"""
    self.parser = parser

def set_tunnelInstance(self, tunnelInstance)

Set the tunnelInstance

Expand source code

def set_tunnelInstance(self, tunnelInstance):
    """Set the tunnelInstance"""
    self.tunnelInstance = tunnelInstance