Module HRecord_pb2 :: Class Record
[hide private]
[frames] | no frames]

Class Record

source code

                     object --+    
                              |    
google.protobuf.message.Message --+
                                  |
                                 Record

Nested Classes [hide private]
  __metaclass__
Metaclass for protocol message classes created at runtime from Descriptors.
  P0I
  P0D
  PXY
  PXYZ
  P1D
  H1D
  H2D
  F1D
  F2D
  FND
  FPR
  PND
  PNI
Instance Methods [hide private]
 
ByteSize(self)
Returns the serialized size of this message.
 
Clear(self)
Clears all data that was set in the message.
 
ClearField(self, field_name)
 
FindInitializationErrors(self)
Finds required fields which are not initialized.
 
HasField(self, field_name)
Checks if a certain field is set for the message.
 
IsInitialized(self, errors=None)
Checks if all required fields of a message are set.
 
ListFields(self)
Returns a list of (FieldDescriptor, value) tuples for all fields in the message which are not empty.
 
MergeFrom(self, msg)
Merges the contents of the specified message into current message.
 
MergeFromString(self, serialized)
Merges serialized protocol buffer data into this message.
 
SerializePartialToString(self)
Serializes the protocol message to a binary string.
 
SerializeToString(self)
Serializes the protocol message to a binary string.
 
SetInParent(self)
Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
 
_InternalParse(self, buffer, pos, end)
 
_InternalSerialize(self, write_bytes)
 
_Modified(self)
Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
 
_SetListener(self, listener)
Internal method used by the protocol message implementation.
 
__eq__(self, other)
Recursively compares two messages by value and structure.
 
__init__(self, **kwargs)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__str__(self)
Outputs a human-readable representation of the message.
 
__unicode__(self)
Outputs a human-readable representation of the message.

Inherited from google.protobuf.message.Message: ClearExtension, CopyFrom, HasExtension, ParseFromString, __deepcopy__, __getstate__, __hash__, __ne__, __setstate__

Inherited from object: __delattr__, __format__, __getattribute__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Static Methods [hide private]
 
FromString(s) source code
 
RegisterExtension(extension_handle) source code
Class Variables [hide private]
  DESCRIPTOR = _descriptor.Descriptor(name= 'Record', full_name=...
  F1D_FIELD_NUMBER = 9
  F2D_FIELD_NUMBER = 10
  FND_FIELD_NUMBER = 11
  FPR_FIELD_NUMBER = 12
  H1D_FIELD_NUMBER = 7
  H2D_FIELD_NUMBER = 8
  NAME_FIELD_NUMBER = 1
  P0D_FIELD_NUMBER = 3
  P0I_FIELD_NUMBER = 2
  P1D_FIELD_NUMBER = 6
  PND_FIELD_NUMBER = 13
  PNI_FIELD_NUMBER = 14
  PXYZ_FIELD_NUMBER = 5
  PXY_FIELD_NUMBER = 4
  _decoders_by_tag = {'\n': <function DecodeField at 0x23ef140>,...
  _extensions_by_name = {}
  _extensions_by_number = {}
Properties [hide private]
  _cached_byte_size
  _cached_byte_size_dirty
  _fields
  _is_present_in_parent
  _listener
  _listener_for_children
  _unknown_fields
  f1D
Magic attribute generated for "f1D" proto field.
  f2D
Magic attribute generated for "f2D" proto field.
  fND
Magic attribute generated for "fND" proto field.
  fPR
Magic attribute generated for "fPR" proto field.
  h1D
Magic attribute generated for "h1D" proto field.
  h2D
Magic attribute generated for "h2D" proto field.
  name
Magic attribute generated for "name" proto field.
  p0D
Magic attribute generated for "p0D" proto field.
  p0I
Magic attribute generated for "p0I" proto field.
  p1D
Magic attribute generated for "p1D" proto field.
  pND
Magic attribute generated for "pND" proto field.
  pNI
Magic attribute generated for "pNI" proto field.
  pXY
Magic attribute generated for "pXY" proto field.
  pXYZ
Magic attribute generated for "pXYZ" proto field.

Inherited from object: __class__

Method Details [hide private]

ByteSize(self)

 

Returns the serialized size of this message. Recursively calls ByteSize() on all contained messages.

Overrides: google.protobuf.message.Message.ByteSize
(inherited documentation)

Clear(self)

 

Clears all data that was set in the message.

Overrides: google.protobuf.message.Message.Clear
(inherited documentation)

ClearField(self, field_name)

 
Overrides: google.protobuf.message.Message.ClearField

FindInitializationErrors(self)

 
Finds required fields which are not initialized.

Returns:
  A list of strings.  Each string is a path to an uninitialized field from
  the top-level message, e.g. "foo.bar[5].baz".

HasField(self, field_name)

 

Checks if a certain field is set for the message. Note if the field_name is not defined in the message descriptor, ValueError will be raised.

Overrides: google.protobuf.message.Message.HasField
(inherited documentation)

IsInitialized(self, errors=None)

 
Checks if all required fields of a message are set.

Args:
  errors:  A list which, if provided, will be populated with the field
           paths of all missing required fields.

Returns:
  True iff the specified message has all required fields set.

Overrides: google.protobuf.message.Message.IsInitialized

ListFields(self)

 

Returns a list of (FieldDescriptor, value) tuples for all fields in the message which are not empty. A singular field is non-empty if HasField() would return true, and a repeated field is non-empty if it contains at least one element. The fields are ordered by field number

Overrides: google.protobuf.message.Message.ListFields
(inherited documentation)

MergeFrom(self, msg)

 
Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current
message. Singular fields that are set in the specified message overwrite
the corresponding fields in the current message. Repeated fields are
appended. Singular sub-messages and groups are recursively merged.

Args:
  other_msg: Message to merge into the current message.

Overrides: google.protobuf.message.Message.MergeFrom
(inherited documentation)

MergeFromString(self, serialized)

 
Merges serialized protocol buffer data into this message.

When we find a field in |serialized| that is already present
in this message:
  - If it's a "repeated" field, we append to the end of our list.
  - Else, if it's a scalar, we overwrite our field.
  - Else, (it's a nonrepeated composite), we recursively merge
    into the existing composite.

TODO(robinson): Document handling of unknown fields.

Args:
  serialized: Any object that allows us to call buffer(serialized)
    to access a string of bytes using the buffer interface.

TODO(robinson): When we switch to a helper, this will return None.

Returns:
  The number of bytes read from |serialized|.
  For non-group messages, this will always be len(serialized),
  but for messages which are actually groups, this will
  generally be less than len(serialized), since we must
  stop when we reach an END_GROUP tag.  Note that if
  we *do* stop because of an END_GROUP tag, the number
  of bytes returned does not include the bytes
  for the END_GROUP tag information.

Overrides: google.protobuf.message.Message.MergeFromString
(inherited documentation)

SerializePartialToString(self)

 
Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the
message is initialized.

Returns:
  A string representation of the partial message.

Overrides: google.protobuf.message.Message.SerializePartialToString
(inherited documentation)

SerializeToString(self)

 
Serializes the protocol message to a binary string.

Returns:
  A binary string representation of the message if all of the required
  fields in the message are set (i.e. the message is initialized).

Raises:
  message.EncodeError if the message isn't initialized.

Overrides: google.protobuf.message.Message.SerializeToString
(inherited documentation)

SetInParent(self)

 

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

Overrides: google.protobuf.message.Message.SetInParent

_SetListener(self, listener)

 

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting "has" bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

Overrides: google.protobuf.message.Message._SetListener
(inherited documentation)

__eq__(self, other)
(Equality operator)

 

Recursively compares two messages by value and structure.

Overrides: google.protobuf.message.Message.__eq__
(inherited documentation)

__init__(self, **kwargs)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

 

Outputs a human-readable representation of the message.

Overrides: object.__str__
(inherited documentation)

__unicode__(self)

 

Outputs a human-readable representation of the message.

Overrides: google.protobuf.message.Message.__unicode__
(inherited documentation)

Class Variable Details [hide private]

DESCRIPTOR

Value:
_descriptor.Descriptor(name= 'Record', full_name= 'promc.Record', file\
name= None, file= DESCRIPTOR, containing_type= None, fields= [_descrip\
tor.FieldDescriptor(name= 'name', full_name= 'promc.Record.name', inde\
x= 0, number= 1, type= 9, cpp_type= 9, label= 1, has_default_value= Fa\
lse, default_value= unicode("", "utf-8"), message_type= None, enum_typ\
e= None, containing_type= None, is_extension= False, extension_scope= \
None, options= None), _descriptor.FieldDescriptor(name= 'p0I', full_na\
me= 'promc.Record.p0I', index= 1, number= 2, type= 11, cpp_type= 10, l\
...

_decoders_by_tag

Value:
{'''
''': <function DecodeField at 0x23ef140>,
 '\x12': <function DecodeField at 0x23ef320>,
 '\x1a': <function DecodeField at 0x23ef500>,
 '"': <function DecodeField at 0x23ef6e0>,
 '*': <function DecodeField at 0x23ef8c0>,
 '2': <function DecodeField at 0x23efaa0>,
 ':': <function DecodeField at 0x23efc80>,
...

Property Details [hide private]

f1D

Magic attribute generated for "f1D" proto field.

Get Method:
unreachable.getter(self) - Getter for f1D.
Set Method:
unreachable.setter(self, new_value)

f2D

Magic attribute generated for "f2D" proto field.

Get Method:
unreachable.getter(self) - Getter for f2D.
Set Method:
unreachable.setter(self, new_value)

fND

Magic attribute generated for "fND" proto field.

Get Method:
unreachable.getter(self) - Getter for fND.
Set Method:
unreachable.setter(self, new_value)

fPR

Magic attribute generated for "fPR" proto field.

Get Method:
unreachable.getter(self) - Getter for fPR.
Set Method:
unreachable.setter(self, new_value)

h1D

Magic attribute generated for "h1D" proto field.

Get Method:
unreachable.getter(self) - Getter for h1D.
Set Method:
unreachable.setter(self, new_value)

h2D

Magic attribute generated for "h2D" proto field.

Get Method:
unreachable.getter(self) - Getter for h2D.
Set Method:
unreachable.setter(self, new_value)

name

Magic attribute generated for "name" proto field.

Get Method:
unreachable.getter(self) - Getter for name.
Set Method:
unreachable.setter(self, new_value) - Setter for name.

p0D

Magic attribute generated for "p0D" proto field.

Get Method:
unreachable.getter(self) - Getter for p0D.
Set Method:
unreachable.setter(self, new_value)

p0I

Magic attribute generated for "p0I" proto field.

Get Method:
unreachable.getter(self) - Getter for p0I.
Set Method:
unreachable.setter(self, new_value)

p1D

Magic attribute generated for "p1D" proto field.

Get Method:
unreachable.getter(self) - Getter for p1D.
Set Method:
unreachable.setter(self, new_value)

pND

Magic attribute generated for "pND" proto field.

Get Method:
unreachable.getter(self) - Getter for pND.
Set Method:
unreachable.setter(self, new_value)

pNI

Magic attribute generated for "pNI" proto field.

Get Method:
unreachable.getter(self) - Getter for pNI.
Set Method:
unreachable.setter(self, new_value)

pXY

Magic attribute generated for "pXY" proto field.

Get Method:
unreachable.getter(self) - Getter for pXY.
Set Method:
unreachable.setter(self, new_value)

pXYZ

Magic attribute generated for "pXYZ" proto field.

Get Method:
unreachable.getter(self) - Getter for pXYZ.
Set Method:
unreachable.setter(self, new_value)