bspcmdline

  1# This file was automatically generated by SWIG (https://www.swig.org).
  2# Version 4.2.1
  3#
  4# Do not make changes to this file unless you know what you are doing - modify
  5# the SWIG interface file instead.
  6
  7from sys import version_info as _swig_python_version_info
  8from mock_rtems import _bspcmdline as _bspcmdline
  9
 10try:
 11    import builtins as __builtin__
 12except ImportError:
 13    import __builtin__
 14
 15def _swig_repr(self):
 16    try:
 17        strthis = "proxy of " + self.this.__repr__()
 18    except __builtin__.Exception:
 19        strthis = ""
 20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
 21
 22
 23def _swig_setattr_nondynamic_instance_variable(set):
 24    def set_instance_attr(self, name, value):
 25        if name == "this":
 26            set(self, name, value)
 27        elif name == "thisown":
 28            self.this.own(value)
 29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
 30            set(self, name, value)
 31        else:
 32            raise AttributeError("You cannot add instance attributes to %s" % self)
 33    return set_instance_attr
 34
 35
 36def _swig_setattr_nondynamic_class_variable(set):
 37    def set_class_attr(cls, name, value):
 38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
 39            set(cls, name, value)
 40        else:
 41            raise AttributeError("You cannot add class attributes to %s" % cls)
 42    return set_class_attr
 43
 44
 45def _swig_add_metaclass(metaclass):
 46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
 47    def wrapper(cls):
 48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
 49    return wrapper
 50
 51
 52class _SwigNonDynamicMeta(type):
 53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
 54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
 55
 56
 57
 58def rtems_bsp_cmdline_get():
 59    r"""
 60    Obtain Pointer to BSP Boot Command String
 61
 62    This method returns a pointer to the BSP Boot Command String. It
 63    is as likely to be NULL as point to a string as most BSPs do not
 64    have a start environment that provides a boot string.
 65    """
 66    return _bspcmdline.rtems_bsp_cmdline_get()
 67
 68def rtems_bsp_cmdline_get_param(name, value, length):
 69    r"""
 70    Obtain COPY of the Entire Matching Argument
 71
 72    This method searches for the argument *name* in the BSP Boot Command
 73    String and returns a copy of the entire string associated with it in
 74    *value* up to a string of *length*. This will include the argument
 75    and any right hand side portion of the string. For example, one might
 76    be returned --mode=FAST if
 77    searching for --mode.
 78
 79    :type name: string, in
 80    :param name: is the arugment to search for
 81    :type value: string, in
 82    :param value: points to where the contents will
 83                   be placed if located.
 84    :type length: int, in
 85    :param length: is the maximum length to copy
 86
 87    :rtype: string
 88    :return: This method returns NULL if not found and
 89                *value* if found.
 90    """
 91    return _bspcmdline.rtems_bsp_cmdline_get_param(name, value, length)
 92
 93def rtems_bsp_cmdline_get_param_rhs(name, value, length):
 94    r"""
 95    Obtain COPY of the Right Hand Side of the Matching Argument
 96
 97    This method searches for the argument *name* in
 98    the BSP Boot Command String and returns the right hand side
 99    associated with it in *value* up to a maximum string *length*.
100    This will NOT include the argument but only any right hand side
101    portion of the string. *  For example, one might be returned FAST if
102    searching for --mode.
103
104    :type name: string, in
105    :param name: is the arugment to search for
106    :type value: string, in
107    :param value: points to where the contents will
108                   be placed if located.
109    :type length: int, in
110    :param length: is the maximum length to copy
111    """
112    return _bspcmdline.rtems_bsp_cmdline_get_param_rhs(name, value, length)
113
114def rtems_bsp_cmdline_get_param_raw(name):
115    r"""
116    Obtain Pointer to the Entire Matching Argument
117
118    This method searches for the argument *name* in
119    the BSP Boot Command String and returns a pointer to the
120    entire string associated with it. This will include the
121    argument and any right hand side portion of the string.
122    For example, one might be returned --mode=FAST if
123    searching for --mode.
124
125    :type name: string, in
126    :param name: is the arugment to search for
127
128    Notes: The pointer will be to the original BSP Command
129          Line string. Exercise caution when using this.
130    """
131    return _bspcmdline.rtems_bsp_cmdline_get_param_raw(name)
def rtems_bsp_cmdline_get():
59def rtems_bsp_cmdline_get():
60    r"""
61    Obtain Pointer to BSP Boot Command String
62
63    This method returns a pointer to the BSP Boot Command String. It
64    is as likely to be NULL as point to a string as most BSPs do not
65    have a start environment that provides a boot string.
66    """
67    return _bspcmdline.rtems_bsp_cmdline_get()

Obtain Pointer to BSP Boot Command String

This method returns a pointer to the BSP Boot Command String. It is as likely to be NULL as point to a string as most BSPs do not have a start environment that provides a boot string.

def rtems_bsp_cmdline_get_param(name, value, length):
69def rtems_bsp_cmdline_get_param(name, value, length):
70    r"""
71    Obtain COPY of the Entire Matching Argument
72
73    This method searches for the argument *name* in the BSP Boot Command
74    String and returns a copy of the entire string associated with it in
75    *value* up to a string of *length*. This will include the argument
76    and any right hand side portion of the string. For example, one might
77    be returned --mode=FAST if
78    searching for --mode.
79
80    :type name: string, in
81    :param name: is the arugment to search for
82    :type value: string, in
83    :param value: points to where the contents will
84                   be placed if located.
85    :type length: int, in
86    :param length: is the maximum length to copy
87
88    :rtype: string
89    :return: This method returns NULL if not found and
90                *value* if found.
91    """
92    return _bspcmdline.rtems_bsp_cmdline_get_param(name, value, length)

Obtain COPY of the Entire Matching Argument

This method searches for the argument name in the BSP Boot Command String and returns a copy of the entire string associated with it in value up to a string of length. This will include the argument and any right hand side portion of the string. For example, one might be returned --mode=FAST if searching for --mode.

Parameters
  • name: is the arugment to search for
  • value: points to where the contents will be placed if located.
  • length: is the maximum length to copy
Returns

This method returns NULL if not found and value if found.

def rtems_bsp_cmdline_get_param_rhs(name, value, length):
 94def rtems_bsp_cmdline_get_param_rhs(name, value, length):
 95    r"""
 96    Obtain COPY of the Right Hand Side of the Matching Argument
 97
 98    This method searches for the argument *name* in
 99    the BSP Boot Command String and returns the right hand side
100    associated with it in *value* up to a maximum string *length*.
101    This will NOT include the argument but only any right hand side
102    portion of the string. *  For example, one might be returned FAST if
103    searching for --mode.
104
105    :type name: string, in
106    :param name: is the arugment to search for
107    :type value: string, in
108    :param value: points to where the contents will
109                   be placed if located.
110    :type length: int, in
111    :param length: is the maximum length to copy
112    """
113    return _bspcmdline.rtems_bsp_cmdline_get_param_rhs(name, value, length)

Obtain COPY of the Right Hand Side of the Matching Argument

This method searches for the argument name in the BSP Boot Command String and returns the right hand side associated with it in value up to a maximum string length. This will NOT include the argument but only any right hand side portion of the string. * For example, one might be returned FAST if searching for --mode.

Parameters
  • name: is the arugment to search for
  • value: points to where the contents will be placed if located.
  • length: is the maximum length to copy
def rtems_bsp_cmdline_get_param_raw(name):
115def rtems_bsp_cmdline_get_param_raw(name):
116    r"""
117    Obtain Pointer to the Entire Matching Argument
118
119    This method searches for the argument *name* in
120    the BSP Boot Command String and returns a pointer to the
121    entire string associated with it. This will include the
122    argument and any right hand side portion of the string.
123    For example, one might be returned --mode=FAST if
124    searching for --mode.
125
126    :type name: string, in
127    :param name: is the arugment to search for
128
129    Notes: The pointer will be to the original BSP Command
130          Line string. Exercise caution when using this.
131    """
132    return _bspcmdline.rtems_bsp_cmdline_get_param_raw(name)

Obtain Pointer to the Entire Matching Argument

This method searches for the argument name in the BSP Boot Command String and returns a pointer to the entire string associated with it. This will include the argument and any right hand side portion of the string. For example, one might be returned --mode=FAST if searching for --mode.

Parameters
  • name: is the arugment to search for

Notes: The pointer will be to the original BSP Command Line string. Exercise caution when using this.