OmniSciDB  c1a53651b2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Private Attributes | List of all members
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor Class Reference
+ Inheritance diagram for heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor:
+ Collaboration diagram for heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor:

Public Member Functions

def __init__
 
def read
 
def write
 
def validate
 
def __repr__
 
def __eq__
 
def __ne__
 

Public Attributes

 layout
 
 keyless
 
 entry_count
 
 idx_target_as_key
 
 min_val
 
 max_val
 
 bucket
 
 group_col_widths
 
 key_bytewidth
 
 col_slot_context
 
 target_groupby_indices
 
 count_distinct_descriptors
 
 force_4byte_float
 

Private Attributes

 __dict__
 

Detailed Description

Attributes:
 - layout
 - keyless
 - entry_count
 - idx_target_as_key
 - min_val
 - max_val
 - bucket
 - group_col_widths
 - key_bytewidth
 - col_slot_context
 - target_groupby_indices
 - count_distinct_descriptors
 - force_4byte_float

Definition at line 365 of file ttypes.py.

Constructor & Destructor Documentation

def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__init__ (   self,
  layout = None,
  keyless = None,
  entry_count = None,
  idx_target_as_key = None,
  min_val = None,
  max_val = None,
  bucket = None,
  group_col_widths = None,
  key_bytewidth = None,
  col_slot_context = None,
  target_groupby_indices = None,
  count_distinct_descriptors = None,
  force_4byte_float = None 
)

Definition at line 385 of file ttypes.py.

385 
386  def __init__(self, layout=None, keyless=None, entry_count=None, idx_target_as_key=None, min_val=None, max_val=None, bucket=None, group_col_widths=None, key_bytewidth=None, col_slot_context=None, target_groupby_indices=None, count_distinct_descriptors=None, force_4byte_float=None,):
387  self.layout = layout
388  self.keyless = keyless
389  self.entry_count = entry_count
390  self.idx_target_as_key = idx_target_as_key
391  self.min_val = min_val
392  self.max_val = max_val
393  self.bucket = bucket
394  self.group_col_widths = group_col_widths
395  self.key_bytewidth = key_bytewidth
396  self.col_slot_context = col_slot_context
397  self.target_groupby_indices = target_groupby_indices
398  self.count_distinct_descriptors = count_distinct_descriptors
399  self.force_4byte_float = force_4byte_float
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.idx_target_as_key
idx_target_as_key
Definition: ttypes.py:389
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.force_4byte_float
force_4byte_float
Definition: ttypes.py:398
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.key_bytewidth
key_bytewidth
Definition: ttypes.py:394
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__init__
def __init__
Definition: ttypes.py:385
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.layout
layout
Definition: ttypes.py:386
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.count_distinct_descriptors
count_distinct_descriptors
Definition: ttypes.py:397
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.max_val
max_val
Definition: ttypes.py:391
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.entry_count
entry_count
Definition: ttypes.py:388
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.keyless
keyless
Definition: ttypes.py:387
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.target_groupby_indices
target_groupby_indices
Definition: ttypes.py:396
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.bucket
bucket
Definition: ttypes.py:392
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.col_slot_context
col_slot_context
Definition: ttypes.py:395
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.group_col_widths
group_col_widths
Definition: ttypes.py:393
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.min_val
min_val
Definition: ttypes.py:390

Member Function Documentation

def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__eq__ (   self,
  other 
)

Definition at line 573 of file ttypes.py.

573 
574  def __eq__(self, other):
575  return isinstance(other, self.__class__) and self.__dict__ == other.__dict__
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__eq__
def __eq__
Definition: ttypes.py:573
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__dict__
__dict__
Definition: ttypes.py:574
def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__ne__ (   self,
  other 
)

Definition at line 576 of file ttypes.py.

576 
577  def __ne__(self, other):
578  return not (self == other)
579 
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__ne__
def __ne__
Definition: ttypes.py:576
def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__repr__ (   self)

Definition at line 568 of file ttypes.py.

568 
569  def __repr__(self):
570  L = ['%s=%r' % (key, value)
571  for key, value in self.__dict__.items()]
572  return '%s(%s)' % (self.__class__.__name__, ', '.join(L))
join
std::string join(T const &container, std::string const &delim)
Definition: StringTransform.h:61
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__repr__
def __repr__
Definition: ttypes.py:568

+ Here is the call graph for this function:

def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read (   self,
  iprot 
)

Definition at line 400 of file ttypes.py.

References heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.bucket, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.col_slot_context, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.count_distinct_descriptors, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.entry_count, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.force_4byte_float, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.group_col_widths, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.idx_target_as_key, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.key_bytewidth, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.keyless, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.layout, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.max_val, heavydb.serialized_result_set.ttypes.TCountDistinctDescriptor.min_val, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.min_val, and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.target_groupby_indices.

400 
401  def read(self, iprot):
402  if iprot._fast_decode is not None and isinstance(iprot.trans, TTransport.CReadableTransport) and self.thrift_spec is not None:
403  iprot._fast_decode(self, iprot, [self.__class__, self.thrift_spec])
404  return
405  iprot.readStructBegin()
406  while True:
407  (fname, ftype, fid) = iprot.readFieldBegin()
408  if ftype == TType.STOP:
409  break
410  if fid == 1:
411  if ftype == TType.I32:
412  self.layout = iprot.readI32()
413  else:
414  iprot.skip(ftype)
415  elif fid == 2:
416  if ftype == TType.BOOL:
417  self.keyless = iprot.readBool()
418  else:
419  iprot.skip(ftype)
420  elif fid == 3:
421  if ftype == TType.I32:
422  self.entry_count = iprot.readI32()
423  else:
424  iprot.skip(ftype)
425  elif fid == 4:
426  if ftype == TType.I32:
427  self.idx_target_as_key = iprot.readI32()
428  else:
429  iprot.skip(ftype)
430  elif fid == 5:
431  if ftype == TType.I64:
432  self.min_val = iprot.readI64()
433  else:
434  iprot.skip(ftype)
435  elif fid == 6:
436  if ftype == TType.I64:
437  self.max_val = iprot.readI64()
438  else:
439  iprot.skip(ftype)
440  elif fid == 7:
441  if ftype == TType.I64:
442  self.bucket = iprot.readI64()
443  else:
444  iprot.skip(ftype)
445  elif fid == 8:
446  if ftype == TType.LIST:
447  self.group_col_widths = []
448  (_etype24, _size21) = iprot.readListBegin()
449  for _i25 in range(_size21):
450  _elem26 = iprot.readI16()
451  self.group_col_widths.append(_elem26)
452  iprot.readListEnd()
453  else:
454  iprot.skip(ftype)
455  elif fid == 9:
456  if ftype == TType.I16:
457  self.key_bytewidth = iprot.readI16()
458  else:
459  iprot.skip(ftype)
460  elif fid == 10:
461  if ftype == TType.STRUCT:
462  self.col_slot_context = TColSlotContext()
463  self.col_slot_context.read(iprot)
464  else:
465  iprot.skip(ftype)
466  elif fid == 11:
467  if ftype == TType.LIST:
468  self.target_groupby_indices = []
469  (_etype30, _size27) = iprot.readListBegin()
470  for _i31 in range(_size27):
471  _elem32 = iprot.readI32()
472  self.target_groupby_indices.append(_elem32)
473  iprot.readListEnd()
474  else:
475  iprot.skip(ftype)
476  elif fid == 12:
477  if ftype == TType.LIST:
478  self.count_distinct_descriptors = []
479  (_etype36, _size33) = iprot.readListBegin()
480  for _i37 in range(_size33):
481  _elem38 = TCountDistinctDescriptor()
482  _elem38.read(iprot)
483  self.count_distinct_descriptors.append(_elem38)
484  iprot.readListEnd()
485  else:
486  iprot.skip(ftype)
487  elif fid == 13:
488  if ftype == TType.BOOL:
489  self.force_4byte_float = iprot.readBool()
490  else:
491  iprot.skip(ftype)
492  else:
493  iprot.skip(ftype)
494  iprot.readFieldEnd()
495  iprot.readStructEnd()
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.idx_target_as_key
idx_target_as_key
Definition: ttypes.py:389
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.force_4byte_float
force_4byte_float
Definition: ttypes.py:398
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.key_bytewidth
key_bytewidth
Definition: ttypes.py:394
heavydb.serialized_result_set.ttypes.TColSlotContext
Definition: ttypes.py:160
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.layout
layout
Definition: ttypes.py:386
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.count_distinct_descriptors
count_distinct_descriptors
Definition: ttypes.py:397
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.max_val
max_val
Definition: ttypes.py:391
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.entry_count
entry_count
Definition: ttypes.py:388
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.keyless
keyless
Definition: ttypes.py:387
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.target_groupby_indices
target_groupby_indices
Definition: ttypes.py:396
heavydb.serialized_result_set.ttypes.TCountDistinctDescriptor
Definition: ttypes.py:253
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read
def read
Definition: ttypes.py:400
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.bucket
bucket
Definition: ttypes.py:392
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.col_slot_context
col_slot_context
Definition: ttypes.py:395
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.group_col_widths
group_col_widths
Definition: ttypes.py:393
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.min_val
min_val
Definition: ttypes.py:390
def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.validate (   self)

Definition at line 565 of file ttypes.py.

565 
566  def validate(self):
567  return
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.validate
def validate
Definition: ttypes.py:565
def heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write (   self,
  oprot 
)

Definition at line 496 of file ttypes.py.

References heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.bucket, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.col_slot_context, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.count_distinct_descriptors, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.entry_count, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.force_4byte_float, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.group_col_widths, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.idx_target_as_key, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.key_bytewidth, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.keyless, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.layout, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.max_val, heavydb.serialized_result_set.ttypes.TCountDistinctDescriptor.min_val, heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.min_val, and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.target_groupby_indices.

496 
497  def write(self, oprot):
498  if oprot._fast_encode is not None and self.thrift_spec is not None:
499  oprot.trans.write(oprot._fast_encode(self, [self.__class__, self.thrift_spec]))
500  return
501  oprot.writeStructBegin('TResultSetBufferDescriptor')
502  if self.layout is not None:
503  oprot.writeFieldBegin('layout', TType.I32, 1)
504  oprot.writeI32(self.layout)
505  oprot.writeFieldEnd()
506  if self.keyless is not None:
507  oprot.writeFieldBegin('keyless', TType.BOOL, 2)
508  oprot.writeBool(self.keyless)
509  oprot.writeFieldEnd()
510  if self.entry_count is not None:
511  oprot.writeFieldBegin('entry_count', TType.I32, 3)
512  oprot.writeI32(self.entry_count)
513  oprot.writeFieldEnd()
514  if self.idx_target_as_key is not None:
515  oprot.writeFieldBegin('idx_target_as_key', TType.I32, 4)
516  oprot.writeI32(self.idx_target_as_key)
517  oprot.writeFieldEnd()
518  if self.min_val is not None:
519  oprot.writeFieldBegin('min_val', TType.I64, 5)
520  oprot.writeI64(self.min_val)
521  oprot.writeFieldEnd()
522  if self.max_val is not None:
523  oprot.writeFieldBegin('max_val', TType.I64, 6)
524  oprot.writeI64(self.max_val)
525  oprot.writeFieldEnd()
526  if self.bucket is not None:
527  oprot.writeFieldBegin('bucket', TType.I64, 7)
528  oprot.writeI64(self.bucket)
529  oprot.writeFieldEnd()
530  if self.group_col_widths is not None:
531  oprot.writeFieldBegin('group_col_widths', TType.LIST, 8)
532  oprot.writeListBegin(TType.I16, len(self.group_col_widths))
533  for iter39 in self.group_col_widths:
534  oprot.writeI16(iter39)
535  oprot.writeListEnd()
536  oprot.writeFieldEnd()
537  if self.key_bytewidth is not None:
538  oprot.writeFieldBegin('key_bytewidth', TType.I16, 9)
539  oprot.writeI16(self.key_bytewidth)
540  oprot.writeFieldEnd()
541  if self.col_slot_context is not None:
542  oprot.writeFieldBegin('col_slot_context', TType.STRUCT, 10)
543  self.col_slot_context.write(oprot)
544  oprot.writeFieldEnd()
545  if self.target_groupby_indices is not None:
546  oprot.writeFieldBegin('target_groupby_indices', TType.LIST, 11)
547  oprot.writeListBegin(TType.I32, len(self.target_groupby_indices))
548  for iter40 in self.target_groupby_indices:
549  oprot.writeI32(iter40)
550  oprot.writeListEnd()
551  oprot.writeFieldEnd()
552  if self.count_distinct_descriptors is not None:
553  oprot.writeFieldBegin('count_distinct_descriptors', TType.LIST, 12)
554  oprot.writeListBegin(TType.STRUCT, len(self.count_distinct_descriptors))
555  for iter41 in self.count_distinct_descriptors:
556  iter41.write(oprot)
557  oprot.writeListEnd()
558  oprot.writeFieldEnd()
559  if self.force_4byte_float is not None:
560  oprot.writeFieldBegin('force_4byte_float', TType.BOOL, 13)
561  oprot.writeBool(self.force_4byte_float)
562  oprot.writeFieldEnd()
563  oprot.writeFieldStop()
564  oprot.writeStructEnd()
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write
def write
Definition: ttypes.py:496
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.idx_target_as_key
idx_target_as_key
Definition: ttypes.py:389
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.force_4byte_float
force_4byte_float
Definition: ttypes.py:398
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.key_bytewidth
key_bytewidth
Definition: ttypes.py:394
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.layout
layout
Definition: ttypes.py:386
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.count_distinct_descriptors
count_distinct_descriptors
Definition: ttypes.py:397
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.max_val
max_val
Definition: ttypes.py:391
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.entry_count
entry_count
Definition: ttypes.py:388
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.keyless
keyless
Definition: ttypes.py:387
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.target_groupby_indices
target_groupby_indices
Definition: ttypes.py:396
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.bucket
bucket
Definition: ttypes.py:392
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.col_slot_context
col_slot_context
Definition: ttypes.py:395
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.group_col_widths
group_col_widths
Definition: ttypes.py:393
heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.min_val
min_val
Definition: ttypes.py:390

Member Data Documentation

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.__dict__
private

Definition at line 574 of file ttypes.py.

Referenced by generate_TableFunctionsFactory_init.Node.copy().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.bucket

Definition at line 392 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), heavydb.thrift.ttypes.TColumnRange.read(), heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write(), and heavydb.thrift.ttypes.TColumnRange.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.col_slot_context

Definition at line 395 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.count_distinct_descriptors

Definition at line 397 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.entry_count

Definition at line 388 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), heavydb.thrift.ttypes.TDictionaryGeneration.read(), heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write(), and heavydb.thrift.ttypes.TDictionaryGeneration.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.force_4byte_float

Definition at line 398 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.group_col_widths

Definition at line 393 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.idx_target_as_key

Definition at line 389 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.key_bytewidth

Definition at line 394 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.keyless

Definition at line 387 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.layout

Definition at line 386 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.max_val

Definition at line 391 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.min_val

Definition at line 390 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.target_groupby_indices

Definition at line 396 of file ttypes.py.

Referenced by heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.read(), and heavydb.serialized_result_set.ttypes.TResultSetBufferDescriptor.write().

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