warehouse::msg::_OrderingCriterion::OrderingCriterion Class Reference

List of all members.

Public Member Functions

def __init__
def deserialize
def deserialize_numpy
def serialize
def serialize_numpy

Public Attributes

 field
 reverse

Private Member Functions

def _get_types

Static Private Attributes

list __slots__ = ['field','reverse']
string _full_text
 _has_header = False
string _md5sum = "b1164c823cb6d86127357198543929de"
list _slot_types = ['string','bool']
string _type = "warehouse/OrderingCriterion"

Detailed Description

Definition at line 6 of file _OrderingCriterion.py.


Member Function Documentation

def warehouse::msg::_OrderingCriterion::OrderingCriterion::__init__ (   self,
  args,
  kwds 
)
Constructor. Any message fields that are implicitly/explicitly
set to None will be assigned a default value. The recommend
use is keyword arguments as this is more robust to future message
changes.  You cannot mix in-order arguments and keyword arguments.

The available fields are:
   field,reverse

@param args: complete set of field values, in .msg order
@param kwds: use keyword arguments corresponding to message field names
to set specific fields. 

Definition at line 22 of file _OrderingCriterion.py.

def warehouse::msg::_OrderingCriterion::OrderingCriterion::_get_types (   self  )  [private]
internal API method

Definition at line 47 of file _OrderingCriterion.py.

def warehouse::msg::_OrderingCriterion::OrderingCriterion::deserialize (   self,
  str 
)
unpack serialized message in str into this message instance
@param str: byte array of serialized message
@type  str: str

Definition at line 67 of file _OrderingCriterion.py.

def warehouse::msg::_OrderingCriterion::OrderingCriterion::deserialize_numpy (   self,
  str,
  numpy 
)
unpack serialized message in str into this message instance using numpy for array types
@param str: byte array of serialized message
@type  str: str
@param numpy: numpy python module
@type  numpy: module

Definition at line 106 of file _OrderingCriterion.py.

def warehouse::msg::_OrderingCriterion::OrderingCriterion::serialize (   self,
  buff 
)
serialize message into buffer
@param buff: buffer
@type  buff: StringIO

Definition at line 53 of file _OrderingCriterion.py.

def warehouse::msg::_OrderingCriterion::OrderingCriterion::serialize_numpy (   self,
  buff,
  numpy 
)
serialize message with numpy array types into buffer
@param buff: buffer
@type  buff: StringIO
@param numpy: numpy python module
@type  numpy module

Definition at line 90 of file _OrderingCriterion.py.


Member Data Documentation

Definition at line 19 of file _OrderingCriterion.py.

Initial value:
"""# Represents an ordering criterion to use in a query result set

# Name of the (nested) field to order by, e.g., "position.x"
# Can also be "_creation_time"
string field

# If true, we'll use descending rather than ascending order
bool reverse
"""

Definition at line 10 of file _OrderingCriterion.py.

Definition at line 9 of file _OrderingCriterion.py.

string warehouse::msg::_OrderingCriterion::OrderingCriterion::_md5sum = "b1164c823cb6d86127357198543929de" [static, private]

Definition at line 7 of file _OrderingCriterion.py.

list warehouse::msg::_OrderingCriterion::OrderingCriterion::_slot_types = ['string','bool'] [static, private]

Definition at line 20 of file _OrderingCriterion.py.

Definition at line 8 of file _OrderingCriterion.py.

Definition at line 40 of file _OrderingCriterion.py.

Definition at line 42 of file _OrderingCriterion.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Defines


warehouse
Author(s): Nate Koenig, Bhaskara Marthi
autogenerated on Fri Jan 11 10:09:03 2013