i2c  1.4.2
RoadNarrows Robotics I2C Package
rnr.basetypes.ByteBuf Class Reference

Public Member Functions

def __init__ (self, size=256)
 
def __del__ (self)
 
def __getitem__ (self, i)
 
def __getslice__ (self, i, j)
 
def __iadd__ (self, y)
 
def __imul__ (self, y)
 
def __iter__ (self)
 
def __len__ (self)
 
def __str__ (self)
 
def __setitem__ (self, i, y)
 
def __setslice__ (self, i, j, y)
 
def __sizeof__ (self)
 
def avail (self)
 
def copyFromSwigObj (self, n, i=0, j=0)
 
def copyToSwigObj (self, n, i=0, j=0)
 
def getSwigObj (self)
 
def getBuffer (self)
 
def sizeof (self)
 
def __init__ (self, size=256)
 
def __del__ (self)
 
def __getitem__ (self, i)
 
def __getslice__ (self, i, j)
 
def __iadd__ (self, y)
 
def __imul__ (self, y)
 
def __iter__ (self)
 
def __len__ (self)
 
def __str__ (self)
 
def __setitem__ (self, i, y)
 
def __setslice__ (self, i, j, y)
 
def __sizeof__ (self)
 
def avail (self)
 
def copyFromSwigObj (self, n, i=0, j=0)
 
def copyToSwigObj (self, n, i=0, j=0)
 
def getSwigObj (self)
 
def getBuffer (self)
 
def sizeof (self)
 
def __init__ (self, size=256)
 
def __del__ (self)
 
def __getitem__ (self, i)
 
def __getslice__ (self, i, j)
 
def __iadd__ (self, y)
 
def __imul__ (self, y)
 
def __iter__ (self)
 
def __len__ (self)
 
def __str__ (self)
 
def __setitem__ (self, i, y)
 
def __setslice__ (self, i, j, y)
 
def __sizeof__ (self)
 
def avail (self)
 
def copyFromSwigObj (self, n, i=0, j=0)
 
def copyToSwigObj (self, n, i=0, j=0)
 
def getSwigObj (self)
 
def getBuffer (self)
 
def sizeof (self)
 

Static Public Member Functions

def Constructor (seq)
 
def Clone (buf)
 
def byte (val)
 
def bytelist (seq)
 
def bytec (val)
 
def bytestring (seq)
 
def Constructor (seq)
 
def Clone (buf)
 
def byte (val)
 
def bytelist (seq)
 
def bytec (val)
 
def bytestring (seq)
 
def Constructor (seq)
 
def Clone (buf)
 
def byte (val)
 
def bytelist (seq)
 
def bytec (val)
 
def bytestring (seq)
 

Public Attributes

 buf
 python byte string
 

Detailed Description

RNR Byte Buffer Class.

    The ByteBuf class provides a wrapper around the byte_t* SWIG object.
    The byte_t is typedef'ed in C as an unsigned char. Byte buffers are used
    in packing and unpacking buffers in function calls.

    Note: There does not seem to be any way to advance the pointer of the
          underlining byte_t* SWIG object, so a copy from/to a python byte
          list (buffer) is required.

Definition at line 67 of file basetypes.py.

Constructor & Destructor Documentation

def rnr.basetypes.ByteBuf.__init__ (   self,
  size = 256 
)
Initialize byte buffer instance.

Parameters:
  size  - Number of bytes of the underlining fixed sized SWIG
          object.

Definition at line 80 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, and rnr.basetypes.ByteBuf._swigObj.

Referenced by rnr.basetypes.ByteBuf.__init__().

80  def __init__(self, size=256):
81  """ Initialize byte buffer instance.
82 
83  Parameters:
84  size - Number of bytes of the underlining fixed sized SWIG
85  object.
86  """
87  ## internal swig object
88  self._swigObj = i2ccore.new_byteArray(size)
89 
90  ## internal swig object fixed buffer size
91  self._size = size
92 
93  ## python byte string
94  self.buf = ''
95 
def __init__(self, size=256)
Definition: basetypes.py:80
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.__del__ (   self)
Delete byte buffer instance. 

Definition at line 97 of file basetypes.py.

References rnr.basetypes.ByteBuf._swigObj.

Referenced by rnr.basetypes.ByteBuf.__del__().

97  def __del__(self):
98  """ Delete byte buffer instance. """
99  i2ccore.delete_byteArray(self._swigObj)
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.__init__ (   self,
  size = 256 
)
Initialize byte buffer instance.

Parameters:
  size  - Number of bytes of the underlining fixed sized SWIG
          object.

Definition at line 80 of file basetypes.py.

References rnr.basetypes.ByteBuf.__init__(), rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

80  def __init__(self, size=256):
81  """ Initialize byte buffer instance.
82 
83  Parameters:
84  size - Number of bytes of the underlining fixed sized SWIG
85  object.
86  """
87  ## internal swig object
88  self._swigObj = i2ccore.new_byteArray(size)
89 
90  ## internal swig object fixed buffer size
91  self._size = size
92 
93  ## python byte string
94  self.buf = ''
95 
def __init__(self, size=256)
Definition: basetypes.py:80
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.__del__ (   self)
Delete byte buffer instance. 

Definition at line 97 of file basetypes.py.

References rnr.basetypes.ByteBuf.__del__(), and rnr.basetypes.ByteBuf._swigObj.

97  def __del__(self):
98  """ Delete byte buffer instance. """
99  i2ccore.delete_byteArray(self._swigObj)
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.__init__ (   self,
  size = 256 
)
Initialize byte buffer instance.

Parameters:
  size  - Number of bytes of the underlining fixed sized SWIG
          object.

Definition at line 80 of file basetypes.py.

References rnr.basetypes.ByteBuf.__init__(), rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

80  def __init__(self, size=256):
81  """ Initialize byte buffer instance.
82 
83  Parameters:
84  size - Number of bytes of the underlining fixed sized SWIG
85  object.
86  """
87  ## internal swig object
88  self._swigObj = i2ccore.new_byteArray(size)
89 
90  ## internal swig object fixed buffer size
91  self._size = size
92 
93  ## python byte string
94  self.buf = ''
95 
def __init__(self, size=256)
Definition: basetypes.py:80
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.__del__ (   self)
Delete byte buffer instance. 

Definition at line 97 of file basetypes.py.

References rnr.basetypes.ByteBuf.__del__(), and rnr.basetypes.ByteBuf._swigObj.

97  def __del__(self):
98  """ Delete byte buffer instance. """
99  i2ccore.delete_byteArray(self._swigObj)
_swigObj
internal swig object
Definition: basetypes.py:88

Member Function Documentation

def rnr.basetypes.ByteBuf.__getitem__ (   self,
  i 
)
x.__getitem__(i)  <==> x[i] 

Definition at line 146 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__getitem__().

146  def __getitem__(self, i):
147  """ x.__getitem__(i) <==> x[i] """
148  return self.buf.__getitem__(i)
def __getitem__(self, i)
Definition: basetypes.py:146
def rnr.basetypes.ByteBuf.__getitem__ (   self,
  i 
)
x.__getitem__(i)  <==> x[i] 

Definition at line 146 of file basetypes.py.

References rnr.basetypes.ByteBuf.__getitem__().

146  def __getitem__(self, i):
147  """ x.__getitem__(i) <==> x[i] """
148  return self.buf.__getitem__(i)
def __getitem__(self, i)
Definition: basetypes.py:146
def rnr.basetypes.ByteBuf.__getitem__ (   self,
  i 
)
x.__getitem__(i)  <==> x[i] 

Definition at line 146 of file basetypes.py.

References rnr.basetypes.ByteBuf.__getitem__().

146  def __getitem__(self, i):
147  """ x.__getitem__(i) <==> x[i] """
148  return self.buf.__getitem__(i)
def __getitem__(self, i)
Definition: basetypes.py:146
def rnr.basetypes.ByteBuf.__getslice__ (   self,
  i,
  j 
)
x.__getslice__(i, j)  <==> x[i:j] 

Definition at line 152 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__getslice__().

152  def __getslice__(self, i, j):
153  """ x.__getslice__(i, j) <==> x[i:j] """
154  return self.buf.__getslice__(i, j)
def __getslice__(self, i, j)
Definition: basetypes.py:152
def rnr.basetypes.ByteBuf.__getslice__ (   self,
  i,
  j 
)
x.__getslice__(i, j)  <==> x[i:j] 

Definition at line 152 of file basetypes.py.

References rnr.basetypes.ByteBuf.__getslice__().

152  def __getslice__(self, i, j):
153  """ x.__getslice__(i, j) <==> x[i:j] """
154  return self.buf.__getslice__(i, j)
def __getslice__(self, i, j)
Definition: basetypes.py:152
def rnr.basetypes.ByteBuf.__getslice__ (   self,
  i,
  j 
)
x.__getslice__(i, j)  <==> x[i:j] 

Definition at line 152 of file basetypes.py.

References rnr.basetypes.ByteBuf.__getslice__().

152  def __getslice__(self, i, j):
153  """ x.__getslice__(i, j) <==> x[i:j] """
154  return self.buf.__getslice__(i, j)
def __getslice__(self, i, j)
Definition: basetypes.py:152
def rnr.basetypes.ByteBuf.__iadd__ (   self,
  y 
)
x.__iadd__(y)  <==> x+=y 

Definition at line 158 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__iadd__().

158  def __iadd__(self, y):
159  """ x.__iadd__(y) <==> x+=y """
160  z = ByteBuf.bytestring(y)
161  self.buf.__iadd__(z)
162  return self
def __iadd__(self, y)
Definition: basetypes.py:158
def rnr.basetypes.ByteBuf.__iadd__ (   self,
  y 
)
x.__iadd__(y)  <==> x+=y 

Definition at line 158 of file basetypes.py.

References rnr.basetypes.ByteBuf.__iadd__().

158  def __iadd__(self, y):
159  """ x.__iadd__(y) <==> x+=y """
160  z = ByteBuf.bytestring(y)
161  self.buf.__iadd__(z)
162  return self
def __iadd__(self, y)
Definition: basetypes.py:158
def rnr.basetypes.ByteBuf.__iadd__ (   self,
  y 
)
x.__iadd__(y)  <==> x+=y 

Definition at line 158 of file basetypes.py.

References rnr.basetypes.ByteBuf.__iadd__().

158  def __iadd__(self, y):
159  """ x.__iadd__(y) <==> x+=y """
160  z = ByteBuf.bytestring(y)
161  self.buf.__iadd__(z)
162  return self
def __iadd__(self, y)
Definition: basetypes.py:158
def rnr.basetypes.ByteBuf.__imul__ (   self,
  y 
)
x.__imul__(y)  <==> x*=y 

Definition at line 166 of file basetypes.py.

References rnr.basetypes.ByteBuf.__imul__().

166  def __imul__(self, y):
167  """ x.__imul__(y) <==> x*=y """
168  self.buf.__imul__(y)
169  return self
def __imul__(self, y)
Definition: basetypes.py:166
def rnr.basetypes.ByteBuf.__imul__ (   self,
  y 
)
x.__imul__(y)  <==> x*=y 

Definition at line 166 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__imul__().

166  def __imul__(self, y):
167  """ x.__imul__(y) <==> x*=y """
168  self.buf.__imul__(y)
169  return self
def __imul__(self, y)
Definition: basetypes.py:166
def rnr.basetypes.ByteBuf.__imul__ (   self,
  y 
)
x.__imul__(y)  <==> x*=y 

Definition at line 166 of file basetypes.py.

References rnr.basetypes.ByteBuf.__imul__().

166  def __imul__(self, y):
167  """ x.__imul__(y) <==> x*=y """
168  self.buf.__imul__(y)
169  return self
def __imul__(self, y)
Definition: basetypes.py:166
def rnr.basetypes.ByteBuf.__iter__ (   self)
x.__iter__()  <==> iter(x) 

Definition at line 173 of file basetypes.py.

References rnr.basetypes.ByteBuf.__iter__().

173  def __iter__(self):
174  """ x.__iter__() <==> iter(x) """
175  return self.buf.__iter__()
def rnr.basetypes.ByteBuf.__iter__ (   self)
x.__iter__()  <==> iter(x) 

Definition at line 173 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__iter__().

173  def __iter__(self):
174  """ x.__iter__() <==> iter(x) """
175  return self.buf.__iter__()
def rnr.basetypes.ByteBuf.__iter__ (   self)
x.__iter__()  <==> iter(x) 

Definition at line 173 of file basetypes.py.

References rnr.basetypes.ByteBuf.__iter__().

173  def __iter__(self):
174  """ x.__iter__() <==> iter(x) """
175  return self.buf.__iter__()
def rnr.basetypes.ByteBuf.__len__ (   self)
x.__len__() <==> len(x)

Number of bytes used in buffer. 

Definition at line 179 of file basetypes.py.

References rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

Referenced by rnr.basetypes.ByteBuf.__len__().

179  def __len__(self):
180  """ x.__len__() <==> len(x)
181 
182  Number of bytes used in buffer.
183  """
184  return len(self.buf)
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.__len__ (   self)
x.__len__() <==> len(x)

Number of bytes used in buffer. 

Definition at line 179 of file basetypes.py.

References rnr.basetypes.ByteBuf.__len__(), rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

179  def __len__(self):
180  """ x.__len__() <==> len(x)
181 
182  Number of bytes used in buffer.
183  """
184  return len(self.buf)
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.__len__ (   self)
x.__len__() <==> len(x)

Number of bytes used in buffer. 

Definition at line 179 of file basetypes.py.

References rnr.basetypes.ByteBuf.__len__(), rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

179  def __len__(self):
180  """ x.__len__() <==> len(x)
181 
182  Number of bytes used in buffer.
183  """
184  return len(self.buf)
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.__setitem__ (   self,
  i,
  y 
)
x.__setitem__(i, y)  <==> x[i]=y 

Definition at line 194 of file basetypes.py.

References rnr.basetypes.ByteBuf.__setitem__(), i2c_smbus_data_union.byte, and rnr.basetypes.ByteBuf.byte().

194  def __setitem__(self, i, y):
195  """ x.__setitem__(i, y) <==> x[i]=y """
196  z = self.byte(y)
197  self.buf.__setitem__(i, z)
198  return self
def __setitem__(self, i, y)
Definition: basetypes.py:194
def rnr.basetypes.ByteBuf.__setitem__ (   self,
  i,
  y 
)
x.__setitem__(i, y)  <==> x[i]=y 

Definition at line 194 of file basetypes.py.

References i2c_smbus_data_union.byte, and rnr.basetypes.ByteBuf.byte().

Referenced by rnr.basetypes.ByteBuf.__setitem__().

194  def __setitem__(self, i, y):
195  """ x.__setitem__(i, y) <==> x[i]=y """
196  z = self.byte(y)
197  self.buf.__setitem__(i, z)
198  return self
def __setitem__(self, i, y)
Definition: basetypes.py:194
def rnr.basetypes.ByteBuf.__setitem__ (   self,
  i,
  y 
)
x.__setitem__(i, y)  <==> x[i]=y 

Definition at line 194 of file basetypes.py.

References rnr.basetypes.ByteBuf.__setitem__(), i2c_smbus_data_union.byte, and rnr.basetypes.ByteBuf.byte().

194  def __setitem__(self, i, y):
195  """ x.__setitem__(i, y) <==> x[i]=y """
196  z = self.byte(y)
197  self.buf.__setitem__(i, z)
198  return self
def __setitem__(self, i, y)
Definition: basetypes.py:194
def rnr.basetypes.ByteBuf.__setslice__ (   self,
  i,
  j,
  y 
)
x.__setslice__(i, j, y)  <==> x[i:j]=y 

Definition at line 202 of file basetypes.py.

References rnr.basetypes.ByteBuf.__setslice__().

202  def __setslice__(self, i, j, y):
203  """ x.__setslice__(i, j, y) <==> x[i:j]=y """
204  z = ByteBuf.bytestring(y)
205  self.buf.__setslice__(i, j, z)
206  return self
def __setslice__(self, i, j, y)
Definition: basetypes.py:202
def rnr.basetypes.ByteBuf.__setslice__ (   self,
  i,
  j,
  y 
)
x.__setslice__(i, j, y)  <==> x[i:j]=y 

Definition at line 202 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__setslice__().

202  def __setslice__(self, i, j, y):
203  """ x.__setslice__(i, j, y) <==> x[i:j]=y """
204  z = ByteBuf.bytestring(y)
205  self.buf.__setslice__(i, j, z)
206  return self
def __setslice__(self, i, j, y)
Definition: basetypes.py:202
def rnr.basetypes.ByteBuf.__setslice__ (   self,
  i,
  j,
  y 
)
x.__setslice__(i, j, y)  <==> x[i:j]=y 

Definition at line 202 of file basetypes.py.

References rnr.basetypes.ByteBuf.__setslice__().

202  def __setslice__(self, i, j, y):
203  """ x.__setslice__(i, j, y) <==> x[i:j]=y """
204  z = ByteBuf.bytestring(y)
205  self.buf.__setslice__(i, j, z)
206  return self
def __setslice__(self, i, j, y)
Definition: basetypes.py:202
def rnr.basetypes.ByteBuf.__sizeof__ (   self)
x.__sizeof__() -- size of swig object byte buffer, in bytes. 

Definition at line 210 of file basetypes.py.

References rnr.basetypes.ByteBuf.__sizeof__(), and rnr.basetypes.ByteBuf._size.

210  def __sizeof__(self):
211  """ x.__sizeof__() -- size of swig object byte buffer, in bytes. """
212  return self._size
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def __sizeof__(self)
Definition: basetypes.py:210
def rnr.basetypes.ByteBuf.__sizeof__ (   self)
x.__sizeof__() -- size of swig object byte buffer, in bytes. 

Definition at line 210 of file basetypes.py.

References rnr.basetypes.ByteBuf._size.

Referenced by rnr.basetypes.ByteBuf.__sizeof__(), and rnr.basetypes.ByteBuf.sizeof().

210  def __sizeof__(self):
211  """ x.__sizeof__() -- size of swig object byte buffer, in bytes. """
212  return self._size
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def __sizeof__(self)
Definition: basetypes.py:210
def rnr.basetypes.ByteBuf.__sizeof__ (   self)
x.__sizeof__() -- size of swig object byte buffer, in bytes. 

Definition at line 210 of file basetypes.py.

References rnr.basetypes.ByteBuf.__sizeof__(), and rnr.basetypes.ByteBuf._size.

210  def __sizeof__(self):
211  """ x.__sizeof__() -- size of swig object byte buffer, in bytes. """
212  return self._size
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def __sizeof__(self)
Definition: basetypes.py:210
def rnr.basetypes.ByteBuf.__str__ (   self)
x.__str__() <==> str(x) <==> print x 

Definition at line 188 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__str__().

188  def __str__(self):
189  """ x.__str__() <==> str(x) <==> print x """
190  return self.buf.__str__()
def rnr.basetypes.ByteBuf.__str__ (   self)
x.__str__() <==> str(x) <==> print x 

Definition at line 188 of file basetypes.py.

References rnr.basetypes.ByteBuf.__str__().

188  def __str__(self):
189  """ x.__str__() <==> str(x) <==> print x """
190  return self.buf.__str__()
def rnr.basetypes.ByteBuf.__str__ (   self)
x.__str__() <==> str(x) <==> print x 

Definition at line 188 of file basetypes.py.

References rnr.basetypes.ByteBuf.__str__().

188  def __str__(self):
189  """ x.__str__() <==> str(x) <==> print x """
190  return self.buf.__str__()
def rnr.basetypes.ByteBuf.avail (   self)
Available bytes in fixed swig object buffer. 

Definition at line 216 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

Referenced by rnr.basetypes.ByteBuf.avail().

216  def avail(self):
217  """ Available bytes in fixed swig object buffer. """
218  return self._size - len(self.buf)
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.avail (   self)
Available bytes in fixed swig object buffer. 

Definition at line 216 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf.avail(), rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

216  def avail(self):
217  """ Available bytes in fixed swig object buffer. """
218  return self._size - len(self.buf)
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.avail (   self)
Available bytes in fixed swig object buffer. 

Definition at line 216 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf.avail(), rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

216  def avail(self):
217  """ Available bytes in fixed swig object buffer. """
218  return self._size - len(self.buf)
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.byte (   val)
static
Static method to convert a value into a byte.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 275 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.__setitem__(), and rnr.basetypes.ByteBuf.byte().

275  def byte(val):
276  """ Static method to convert a value into a byte.
277 
278  Parameters:
279  val - Value to convert. Value type can be an integer [0,255],
280  a string of length 1, or a list of length 1 of element
281  type of integer, string, list.
282 
283  Return:
284  On success, returns converted byte value.
285  On failure, a BotSenseError exception is raised.
286  """
287  if type(val) == int:
288  assert val <= 255, "integer too big"
289  return val
290  elif type(val) == str:
291  assert len(val) == 1, "string too long"
292  return ord(val[0])
293  elif type(val) == list:
294  assert len(val) == 1, "too many list eleements"
295  return ByteBuf.byte(val[0])
296  else:
297  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.byte (   val)
static
Static method to convert a value into a byte.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 275 of file basetypes.py.

References rnr.basetypes.ByteBuf.byte().

275  def byte(val):
276  """ Static method to convert a value into a byte.
277 
278  Parameters:
279  val - Value to convert. Value type can be an integer [0,255],
280  a string of length 1, or a list of length 1 of element
281  type of integer, string, list.
282 
283  Return:
284  On success, returns converted byte value.
285  On failure, a BotSenseError exception is raised.
286  """
287  if type(val) == int:
288  assert val <= 255, "integer too big"
289  return val
290  elif type(val) == str:
291  assert len(val) == 1, "string too long"
292  return ord(val[0])
293  elif type(val) == list:
294  assert len(val) == 1, "too many list eleements"
295  return ByteBuf.byte(val[0])
296  else:
297  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.byte (   val)
static
Static method to convert a value into a byte.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 275 of file basetypes.py.

References rnr.basetypes.ByteBuf.byte().

275  def byte(val):
276  """ Static method to convert a value into a byte.
277 
278  Parameters:
279  val - Value to convert. Value type can be an integer [0,255],
280  a string of length 1, or a list of length 1 of element
281  type of integer, string, list.
282 
283  Return:
284  On success, returns converted byte value.
285  On failure, a BotSenseError exception is raised.
286  """
287  if type(val) == int:
288  assert val <= 255, "integer too big"
289  return val
290  elif type(val) == str:
291  assert len(val) == 1, "string too long"
292  return ord(val[0])
293  elif type(val) == list:
294  assert len(val) == 1, "too many list eleements"
295  return ByteBuf.byte(val[0])
296  else:
297  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytec (   val)
static
Static method to convert a value into a byte character string.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 330 of file basetypes.py.

References rnr.basetypes.ByteBuf.bytec().

330  def bytec(val):
331  """ Static method to convert a value into a byte character string.
332 
333  Parameters:
334  val - Value to convert. Value type can be an integer [0,255],
335  a string of length 1, or a list of length 1 of element
336  type of integer, string, list.
337 
338  Return:
339  On success, returns converted byte value.
340  On failure, a BotSenseError exception is raised.
341  """
342  if type(val) == int:
343  assert val <= 255, "integer too big"
344  return chr(val)
345  elif type(val) == str:
346  assert len(val) == 1, "string too long"
347  return val[0]
348  elif type(val) == list:
349  assert len(val) == 1, "too many list elements"
350  return ByteBuf.bytec(val[0])
351  else:
352  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytec (   val)
static
Static method to convert a value into a byte character string.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 330 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.bytec().

330  def bytec(val):
331  """ Static method to convert a value into a byte character string.
332 
333  Parameters:
334  val - Value to convert. Value type can be an integer [0,255],
335  a string of length 1, or a list of length 1 of element
336  type of integer, string, list.
337 
338  Return:
339  On success, returns converted byte value.
340  On failure, a BotSenseError exception is raised.
341  """
342  if type(val) == int:
343  assert val <= 255, "integer too big"
344  return chr(val)
345  elif type(val) == str:
346  assert len(val) == 1, "string too long"
347  return val[0]
348  elif type(val) == list:
349  assert len(val) == 1, "too many list elements"
350  return ByteBuf.bytec(val[0])
351  else:
352  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytec (   val)
static
Static method to convert a value into a byte character string.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 330 of file basetypes.py.

References rnr.basetypes.ByteBuf.bytec().

330  def bytec(val):
331  """ Static method to convert a value into a byte character string.
332 
333  Parameters:
334  val - Value to convert. Value type can be an integer [0,255],
335  a string of length 1, or a list of length 1 of element
336  type of integer, string, list.
337 
338  Return:
339  On success, returns converted byte value.
340  On failure, a BotSenseError exception is raised.
341  """
342  if type(val) == int:
343  assert val <= 255, "integer too big"
344  return chr(val)
345  elif type(val) == str:
346  assert len(val) == 1, "string too long"
347  return val[0]
348  elif type(val) == list:
349  assert len(val) == 1, "too many list elements"
350  return ByteBuf.bytec(val[0])
351  else:
352  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytelist (   seq)
static
Static method to convert a value sequence into a byte list.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 302 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.bytelist().

302  def bytelist(seq):
303  """ Static method to convert a value sequence into a byte list.
304 
305  Parameters:
306  seq - Sequence of values to convert. Sequence type can be an
307  integer [0,255], a string, or a list of elements of
308  type integer, string, list.
309 
310  Return:
311  On success, returns converted byte value list.
312  On failure, a BotSenseError exception is raised.
313  """
314  if seq is None:
315  return []
316  elif type(seq) == int:
317  outbuf = [ ByteBuf.byte(seq) ]
318  return outbuf
319  elif type(seq) == str or type(seq) == list:
320  outbuf = []
321  for val in seq:
322  outbuf += [ ByteBuf.byte(val) ]
323  return outbuf
324  else:
325  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytelist (   seq)
static
Static method to convert a value sequence into a byte list.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 302 of file basetypes.py.

References rnr.basetypes.ByteBuf.bytelist().

302  def bytelist(seq):
303  """ Static method to convert a value sequence into a byte list.
304 
305  Parameters:
306  seq - Sequence of values to convert. Sequence type can be an
307  integer [0,255], a string, or a list of elements of
308  type integer, string, list.
309 
310  Return:
311  On success, returns converted byte value list.
312  On failure, a BotSenseError exception is raised.
313  """
314  if seq is None:
315  return []
316  elif type(seq) == int:
317  outbuf = [ ByteBuf.byte(seq) ]
318  return outbuf
319  elif type(seq) == str or type(seq) == list:
320  outbuf = []
321  for val in seq:
322  outbuf += [ ByteBuf.byte(val) ]
323  return outbuf
324  else:
325  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytelist (   seq)
static
Static method to convert a value sequence into a byte list.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 302 of file basetypes.py.

References rnr.basetypes.ByteBuf.bytelist().

302  def bytelist(seq):
303  """ Static method to convert a value sequence into a byte list.
304 
305  Parameters:
306  seq - Sequence of values to convert. Sequence type can be an
307  integer [0,255], a string, or a list of elements of
308  type integer, string, list.
309 
310  Return:
311  On success, returns converted byte value list.
312  On failure, a BotSenseError exception is raised.
313  """
314  if seq is None:
315  return []
316  elif type(seq) == int:
317  outbuf = [ ByteBuf.byte(seq) ]
318  return outbuf
319  elif type(seq) == str or type(seq) == list:
320  outbuf = []
321  for val in seq:
322  outbuf += [ ByteBuf.byte(val) ]
323  return outbuf
324  else:
325  assert 0, "unsupported type"
def rnr.basetypes.ByteBuf.bytestring (   seq)
static
Static method to convert a value sequence into a byte string.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 357 of file basetypes.py.

References rnr.basetypes.ByteBuf.bytestring().

357  def bytestring(seq):
358  """ Static method to convert a value sequence into a byte string.
359 
360  Parameters:
361  seq - Sequence of values to convert. Sequence type can be an
362  integer [0,255], a string, or a list of elements of
363  type integer, string, list.
364 
365  Return:
366  On success, returns converted byte value list.
367  On failure, a BotSenseError exception is raised.
368  """
369  if seq is None:
370  return ''
371  elif type(seq) == int:
372  return ByteBuf.bytec(seq)
373  elif type(seq) == str or type(seq) == list:
374  outbuf = ''
375  for val in seq:
376  outbuf += ByteBuf.bytec(val)
377  return outbuf
378  else:
379  assert 0, "unsupported type"
380 
381 
def rnr.basetypes.ByteBuf.bytestring (   seq)
static
Static method to convert a value sequence into a byte string.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 357 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.bytestring().

357  def bytestring(seq):
358  """ Static method to convert a value sequence into a byte string.
359 
360  Parameters:
361  seq - Sequence of values to convert. Sequence type can be an
362  integer [0,255], a string, or a list of elements of
363  type integer, string, list.
364 
365  Return:
366  On success, returns converted byte value list.
367  On failure, a BotSenseError exception is raised.
368  """
369  if seq is None:
370  return ''
371  elif type(seq) == int:
372  return ByteBuf.bytec(seq)
373  elif type(seq) == str or type(seq) == list:
374  outbuf = ''
375  for val in seq:
376  outbuf += ByteBuf.bytec(val)
377  return outbuf
378  else:
379  assert 0, "unsupported type"
380 
381 
def rnr.basetypes.ByteBuf.bytestring (   seq)
static
Static method to convert a value sequence into a byte string.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 357 of file basetypes.py.

References rnr.basetypes.ByteBuf.bytestring().

357  def bytestring(seq):
358  """ Static method to convert a value sequence into a byte string.
359 
360  Parameters:
361  seq - Sequence of values to convert. Sequence type can be an
362  integer [0,255], a string, or a list of elements of
363  type integer, string, list.
364 
365  Return:
366  On success, returns converted byte value list.
367  On failure, a BotSenseError exception is raised.
368  """
369  if seq is None:
370  return ''
371  elif type(seq) == int:
372  return ByteBuf.bytec(seq)
373  elif type(seq) == str or type(seq) == list:
374  outbuf = ''
375  for val in seq:
376  outbuf += ByteBuf.bytec(val)
377  return outbuf
378  else:
379  assert 0, "unsupported type"
380 
381 
def rnr.basetypes.ByteBuf.Clone (   buf)
static
Smart clone constructor.

If buf is a ByteBuf instance, then simply return buf.
Otherwise convert buf to a ByteBuf instance.

The underlining swig object contents are not touched, so swig copies
will need to be done prior to or after calling a byte_t* core routine.

Parameters:
  buf   - Either a ByteBuf instance or a sequence of values to convert.
          Sequence type can be an integer [0,255], a string, or a list
          of elements of type integer, string, list.

Return:
  Existing or new ByteBuf().

Definition at line 122 of file basetypes.py.

References rnr.basetypes.ByteBuf.Clone().

122  def Clone(buf):
123  """ Smart clone constructor.
124 
125  If buf is a ByteBuf instance, then simply return buf.
126  Otherwise convert buf to a ByteBuf instance.
127 
128  The underlining swig object contents are not touched, so swig copies
129  will need to be done prior to or after calling a byte_t* core routine.
130 
131  Parameters:
132  buf - Either a ByteBuf instance or a sequence of values to convert.
133  Sequence type can be an integer [0,255], a string, or a list
134  of elements of type integer, string, list.
135 
136  Return:
137  Existing or new ByteBuf().
138  """
139  if isinstance(buf, ByteBuf):
140  return buf
141  else:
142  return ByteBuf.Constructor(buf)
def rnr.basetypes.ByteBuf.Clone (   buf)
static
Smart clone constructor.

If buf is a ByteBuf instance, then simply return buf.
Otherwise convert buf to a ByteBuf instance.

The underlining swig object contents are not touched, so swig copies
will need to be done prior to or after calling a byte_t* core routine.

Parameters:
  buf   - Either a ByteBuf instance or a sequence of values to convert.
          Sequence type can be an integer [0,255], a string, or a list
          of elements of type integer, string, list.

Return:
  Existing or new ByteBuf().

Definition at line 122 of file basetypes.py.

References rnr.basetypes.ByteBuf.Clone().

122  def Clone(buf):
123  """ Smart clone constructor.
124 
125  If buf is a ByteBuf instance, then simply return buf.
126  Otherwise convert buf to a ByteBuf instance.
127 
128  The underlining swig object contents are not touched, so swig copies
129  will need to be done prior to or after calling a byte_t* core routine.
130 
131  Parameters:
132  buf - Either a ByteBuf instance or a sequence of values to convert.
133  Sequence type can be an integer [0,255], a string, or a list
134  of elements of type integer, string, list.
135 
136  Return:
137  Existing or new ByteBuf().
138  """
139  if isinstance(buf, ByteBuf):
140  return buf
141  else:
142  return ByteBuf.Constructor(buf)
def rnr.basetypes.ByteBuf.Clone (   buf)
static
Smart clone constructor.

If buf is a ByteBuf instance, then simply return buf.
Otherwise convert buf to a ByteBuf instance.

The underlining swig object contents are not touched, so swig copies
will need to be done prior to or after calling a byte_t* core routine.

Parameters:
  buf   - Either a ByteBuf instance or a sequence of values to convert.
          Sequence type can be an integer [0,255], a string, or a list
          of elements of type integer, string, list.

Return:
  Existing or new ByteBuf().

Definition at line 122 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.Clone().

122  def Clone(buf):
123  """ Smart clone constructor.
124 
125  If buf is a ByteBuf instance, then simply return buf.
126  Otherwise convert buf to a ByteBuf instance.
127 
128  The underlining swig object contents are not touched, so swig copies
129  will need to be done prior to or after calling a byte_t* core routine.
130 
131  Parameters:
132  buf - Either a ByteBuf instance or a sequence of values to convert.
133  Sequence type can be an integer [0,255], a string, or a list
134  of elements of type integer, string, list.
135 
136  Return:
137  Existing or new ByteBuf().
138  """
139  if isinstance(buf, ByteBuf):
140  return buf
141  else:
142  return ByteBuf.Constructor(buf)
def rnr.basetypes.ByteBuf.Constructor (   seq)
static
Conversion constructor.

Parameters:
  seq   - Sequence of values to convert. Sequence type can be an
          integer [0,255], a string, or a list of elements of
          type integer, string, list.

Return:
  New initialized ByteBuf().

Definition at line 104 of file basetypes.py.

References rnr.basetypes.ByteBuf.Constructor().

104  def Constructor(seq):
105  """ Conversion constructor.
106 
107  Parameters:
108  seq - Sequence of values to convert. Sequence type can be an
109  integer [0,255], a string, or a list of elements of
110  type integer, string, list.
111 
112  Return:
113  New initialized ByteBuf().
114  """
115  buf = ByteBuf.bytestring(seq)
116  bytebuf = ByteBuf(size=len(buf))
117  bytebuf.buf = buf
118  return bytebuf
119 
def rnr.basetypes.ByteBuf.Constructor (   seq)
static
Conversion constructor.

Parameters:
  seq   - Sequence of values to convert. Sequence type can be an
          integer [0,255], a string, or a list of elements of
          type integer, string, list.

Return:
  New initialized ByteBuf().

Definition at line 104 of file basetypes.py.

References rnr.basetypes.ByteBuf.Constructor().

104  def Constructor(seq):
105  """ Conversion constructor.
106 
107  Parameters:
108  seq - Sequence of values to convert. Sequence type can be an
109  integer [0,255], a string, or a list of elements of
110  type integer, string, list.
111 
112  Return:
113  New initialized ByteBuf().
114  """
115  buf = ByteBuf.bytestring(seq)
116  bytebuf = ByteBuf(size=len(buf))
117  bytebuf.buf = buf
118  return bytebuf
119 
def rnr.basetypes.ByteBuf.Constructor (   seq)
static
Conversion constructor.

Parameters:
  seq   - Sequence of values to convert. Sequence type can be an
          integer [0,255], a string, or a list of elements of
          type integer, string, list.

Return:
  New initialized ByteBuf().

Definition at line 104 of file basetypes.py.

Referenced by rnr.basetypes.ByteBuf.Constructor().

104  def Constructor(seq):
105  """ Conversion constructor.
106 
107  Parameters:
108  seq - Sequence of values to convert. Sequence type can be an
109  integer [0,255], a string, or a list of elements of
110  type integer, string, list.
111 
112  Return:
113  New initialized ByteBuf().
114  """
115  buf = ByteBuf.bytestring(seq)
116  bytebuf = ByteBuf(size=len(buf))
117  bytebuf.buf = buf
118  return bytebuf
119 
def rnr.basetypes.ByteBuf.copyFromSwigObj (   self,
  n,
  i = 0,
  j = 0 
)
Copy swig object buffer to python buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in swig object buffer.
  j   - Starting destination index in python buffer.

Definition at line 222 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, i2c_msg_struct.buf, and rnr.basetypes.ByteBuf.copyFromSwigObj().

222  def copyFromSwigObj(self, n, i=0, j=0):
223  """ Copy swig object buffer to python buffer.
224 
225  Parameters:
226  n - Number of bytes to copy.
227  i - Starting source index in swig object buffer.
228  j - Starting destination index in python buffer.
229  """
230  assert i+n <= self._size, "index out of range"
231  l = len(self.buf)
232  if l < j+n:
233  self.buf += chr(0) * (j + n - l)
234  s = ''
235  for k in xrange(n):
236  s += chr(i2ccore.byteArray_getitem(self._swigObj, i+k))
237  self.buf = self.buf[:j] + s
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def copyFromSwigObj(self, n, i=0, j=0)
Definition: basetypes.py:222
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.copyFromSwigObj (   self,
  n,
  i = 0,
  j = 0 
)
Copy swig object buffer to python buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in swig object buffer.
  j   - Starting destination index in python buffer.

Definition at line 222 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, i2c_msg_struct.buf, and rnr.basetypes.ByteBuf.copyFromSwigObj().

222  def copyFromSwigObj(self, n, i=0, j=0):
223  """ Copy swig object buffer to python buffer.
224 
225  Parameters:
226  n - Number of bytes to copy.
227  i - Starting source index in swig object buffer.
228  j - Starting destination index in python buffer.
229  """
230  assert i+n <= self._size, "index out of range"
231  l = len(self.buf)
232  if l < j+n:
233  self.buf += chr(0) * (j + n - l)
234  s = ''
235  for k in xrange(n):
236  s += chr(i2ccore.byteArray_getitem(self._swigObj, i+k))
237  self.buf = self.buf[:j] + s
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def copyFromSwigObj(self, n, i=0, j=0)
Definition: basetypes.py:222
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.copyFromSwigObj (   self,
  n,
  i = 0,
  j = 0 
)
Copy swig object buffer to python buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in swig object buffer.
  j   - Starting destination index in python buffer.

Definition at line 222 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

Referenced by rnr.basetypes.ByteBuf.copyFromSwigObj().

222  def copyFromSwigObj(self, n, i=0, j=0):
223  """ Copy swig object buffer to python buffer.
224 
225  Parameters:
226  n - Number of bytes to copy.
227  i - Starting source index in swig object buffer.
228  j - Starting destination index in python buffer.
229  """
230  assert i+n <= self._size, "index out of range"
231  l = len(self.buf)
232  if l < j+n:
233  self.buf += chr(0) * (j + n - l)
234  s = ''
235  for k in xrange(n):
236  s += chr(i2ccore.byteArray_getitem(self._swigObj, i+k))
237  self.buf = self.buf[:j] + s
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def copyFromSwigObj(self, n, i=0, j=0)
Definition: basetypes.py:222
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.copyToSwigObj (   self,
  n,
  i = 0,
  j = 0 
)
Copy python buffer to instance swig object buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in python buffer.
  j   - Starting destination index in swig object buffer.

Definition at line 241 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, i2c_msg_struct.buf, and rnr.basetypes.ByteBuf.copyToSwigObj().

241  def copyToSwigObj(self, n, i=0, j=0):
242  """ Copy python buffer to instance swig object buffer.
243 
244  Parameters:
245  n - Number of bytes to copy.
246  i - Starting source index in python buffer.
247  j - Starting destination index in swig object buffer.
248  """
249  assert i+n <= len(self.buf), "index out of range"
250  assert j+n <= self._size, "index out of range"
251  for k in xrange(n):
252  i2ccore.byteArray_setitem(self._swigObj, j+k, ord(self.buf[i+k]))
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def copyToSwigObj(self, n, i=0, j=0)
Definition: basetypes.py:241
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.copyToSwigObj (   self,
  n,
  i = 0,
  j = 0 
)
Copy python buffer to instance swig object buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in python buffer.
  j   - Starting destination index in swig object buffer.

Definition at line 241 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, i2c_msg_struct.buf, and rnr.basetypes.ByteBuf.copyToSwigObj().

241  def copyToSwigObj(self, n, i=0, j=0):
242  """ Copy python buffer to instance swig object buffer.
243 
244  Parameters:
245  n - Number of bytes to copy.
246  i - Starting source index in python buffer.
247  j - Starting destination index in swig object buffer.
248  """
249  assert i+n <= len(self.buf), "index out of range"
250  assert j+n <= self._size, "index out of range"
251  for k in xrange(n):
252  i2ccore.byteArray_setitem(self._swigObj, j+k, ord(self.buf[i+k]))
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def copyToSwigObj(self, n, i=0, j=0)
Definition: basetypes.py:241
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.copyToSwigObj (   self,
  n,
  i = 0,
  j = 0 
)
Copy python buffer to instance swig object buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in python buffer.
  j   - Starting destination index in swig object buffer.

Definition at line 241 of file basetypes.py.

References rnr.basetypes.ByteBuf._size, rnr.basetypes.ByteBuf._swigObj, rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

Referenced by rnr.basetypes.ByteBuf.copyToSwigObj().

241  def copyToSwigObj(self, n, i=0, j=0):
242  """ Copy python buffer to instance swig object buffer.
243 
244  Parameters:
245  n - Number of bytes to copy.
246  i - Starting source index in python buffer.
247  j - Starting destination index in swig object buffer.
248  """
249  assert i+n <= len(self.buf), "index out of range"
250  assert j+n <= self._size, "index out of range"
251  for k in xrange(n):
252  i2ccore.byteArray_setitem(self._swigObj, j+k, ord(self.buf[i+k]))
_size
internal swig object fixed buffer size
Definition: basetypes.py:91
def copyToSwigObj(self, n, i=0, j=0)
Definition: basetypes.py:241
buf
python byte string
Definition: basetypes.py:94
_swigObj
internal swig object
Definition: basetypes.py:88
def rnr.basetypes.ByteBuf.getBuffer (   self)
Return python buffer. 

Definition at line 262 of file basetypes.py.

References rnr.basetypes.ByteBuf.buf, i2c_msg_struct.buf, and rnr.basetypes.ByteBuf.getBuffer().

262  def getBuffer(self):
263  """ Return python buffer. """
264  return self.buf
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.getBuffer (   self)
Return python buffer. 

Definition at line 262 of file basetypes.py.

References rnr.basetypes.ByteBuf.buf, i2c_msg_struct.buf, and rnr.basetypes.ByteBuf.getBuffer().

262  def getBuffer(self):
263  """ Return python buffer. """
264  return self.buf
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.getBuffer (   self)
Return python buffer. 

Definition at line 262 of file basetypes.py.

References rnr.basetypes.ByteBuf.buf, and i2c_msg_struct.buf.

Referenced by rnr.basetypes.ByteBuf.getBuffer().

262  def getBuffer(self):
263  """ Return python buffer. """
264  return self.buf
buf
python byte string
Definition: basetypes.py:94
def rnr.basetypes.ByteBuf.getSwigObj (   self)
Return raw swig object. 

Definition at line 256 of file basetypes.py.

References rnr.basetypes.ByteBuf._swigObj, and rnr.basetypes.ByteBuf.getSwigObj().

256  def getSwigObj(self):
257  """ Return raw swig object. """
258  return self._swigObj
_swigObj
internal swig object
Definition: basetypes.py:88
def getSwigObj(self)
Definition: basetypes.py:256
def rnr.basetypes.ByteBuf.getSwigObj (   self)
Return raw swig object. 

Definition at line 256 of file basetypes.py.

References rnr.basetypes.ByteBuf._swigObj, and rnr.basetypes.ByteBuf.getSwigObj().

256  def getSwigObj(self):
257  """ Return raw swig object. """
258  return self._swigObj
_swigObj
internal swig object
Definition: basetypes.py:88
def getSwigObj(self)
Definition: basetypes.py:256
def rnr.basetypes.ByteBuf.getSwigObj (   self)
Return raw swig object. 

Definition at line 256 of file basetypes.py.

References rnr.basetypes.ByteBuf._swigObj.

Referenced by rnr.basetypes.ByteBuf.getSwigObj().

256  def getSwigObj(self):
257  """ Return raw swig object. """
258  return self._swigObj
_swigObj
internal swig object
Definition: basetypes.py:88
def getSwigObj(self)
Definition: basetypes.py:256
def rnr.basetypes.ByteBuf.sizeof (   self)
Size of fixed swig object byte buffer, in bytes. 

Definition at line 268 of file basetypes.py.

References rnr.basetypes.ByteBuf.__sizeof__().

Referenced by rnr.basetypes.ByteBuf.sizeof().

268  def sizeof(self):
269  """ Size of fixed swig object byte buffer, in bytes. """
270  return self.__sizeof__()
def __sizeof__(self)
Definition: basetypes.py:210
def rnr.basetypes.ByteBuf.sizeof (   self)
Size of fixed swig object byte buffer, in bytes. 

Definition at line 268 of file basetypes.py.

References rnr.basetypes.ByteBuf.__sizeof__(), and rnr.basetypes.ByteBuf.sizeof().

268  def sizeof(self):
269  """ Size of fixed swig object byte buffer, in bytes. """
270  return self.__sizeof__()
def __sizeof__(self)
Definition: basetypes.py:210
def rnr.basetypes.ByteBuf.sizeof (   self)
Size of fixed swig object byte buffer, in bytes. 

Definition at line 268 of file basetypes.py.

References rnr.basetypes.ByteBuf.__sizeof__(), and rnr.basetypes.ByteBuf.sizeof().

268  def sizeof(self):
269  """ Size of fixed swig object byte buffer, in bytes. """
270  return self.__sizeof__()
def __sizeof__(self)
Definition: basetypes.py:210

The documentation for this class was generated from the following file:
  • pyModules/build.x86_64/lib.linux-x86_64-2.7/rnr/basetypes.py