| | |
- Boost.Python.instance(__builtin__.object)
-
- Interval
- ObjectReader
- ObjectWriter
- ReadableObject
- ReturnStatus
- WriteableObject
-
- SerializableObject(WriteableObject, ReadableObject)
-
- GUID
class GUID(SerializableObject) |
| | |
- Method resolution order:
- GUID
- SerializableObject
- WriteableObject
- ReadableObject
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __eq__(...)
- __getstate__(...)
- __hash__(...)
- __init__(...)
- __init__()
Creates an empty GUID equal to PyJuggler.vpr.GUID.NullGUID.
__init__(GenerateTag)
Creates a new, non-empty GUID.
__init__(guid_string)
Generates a GUID from the given string representation of the GUID
using a string.
Format: "8x-4x-4x-2x2x-2x2x2x2x2x2x"
Arguments:
guid_string -- A string that is used to initialize a GUID.
__init__(GUID, 'name')
Generates a GUID based on the given name that is part of the
namespace identified by the given namespace GUID.
- __lt__(...)
- __ne__(...)
- __reduce__ = (...)
- __setstate__(...)
- __str__(...)
- generate(...)
- toString(...)
- Converts this GUID to its corresponding string representation.
Properties defined here:
- NullGUID
- get = (...)
- generateTag
- get = (...)
Data and other attributes defined here:
- GenerateTag = <class 'PyJuggler.vpr.GenerateTag'>
- Tag to the constructor to force generation.
- __instance_size__ = 36
- __safe_for_unpickling__ = True
- hash = <class 'PyJuggler.vpr.hash'>
- Hasher for vpr.GUID. This can be used with std::hash_map and
friends.
Methods inherited from WriteableObject:
- writeObject(...)
- writeObject(writer) -> PyJuggler.vpr.ReturnStatus object
Template method for writing this object to the given stream.
<b>Post condition:</b> All object data is written to the writer.
Methods inherited from ReadableObject:
- readObject(...)
- readObject(reader) -> PyJuggler.vpr.ReturnStatus object
Template method for reading into this object from the given
stream.
<b>Post condition:</b> All object data is read from the reader.
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class Interval(Boost.Python.instance) |
| |
This class captures an high-resolution interval.
This interval is based off an unsigned always increasing
counter. This means that the interval is only accurate for about
12 hours and that it is able to be useful for a range of roughly
6 hours. (This is because, internally, everything is stored as
tens of microseconds.)
The interval overflows whenever the counter maxes out.
The __sub__() routine will take care of the overflow automatically
to make it possible to compare to interval values.
|
| |
- Method resolution order:
- Interval
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __add__(...)
- __eq__(...)
- __getstate__(...)
- __gt__(...)
- __iadd__(...)
- __init__(...)
- __init__()
Default constructor sets the internal timer to 0.
__init__(num, timeUnit)
Constructor that takes an integer number and a unit of time and
stores it in the internal timer as the interval.
- __isub__(...)
- __le__(...)
- __lt__(...)
- __ne__(...)
- __reduce__ = (...)
- __setstate__(...)
- __sub__(...)
- getBaseVal(...)
- getBaseVal() -> int
Returns the value of this interval in microseconds as an
integer.
- msec(...)
- msec(value)
Given an amount of time in milliseconds as an integer, store
it as this the value of interval.
msec() -> int
Returns the value of this interval in milliseconds as an
integer.
- msecd(...)
- msecd(value)
Given an amount of time in seconds as a double-precision
floating-point value, store it as the value of this interval.
msecd() -> float
Returns the value of this interval in milliseconds as a
double-precision floating-point value.
- msecf(...)
- msecf(value)
Given an amount of time in seconds as a single-precision
floating-point value, store it as the value of this interval.
msecf() -> float
Returns the value of this interval in milliseconds as a
single-precision floating-point value.
- sec(...)
- sec(value)
Given an amount of time in seconds as an integer, store it
as this the value of interval.
sec() -> int
Returns the value of this interval in seconds as an integer.
- secd(...)
- secd(value)
Given an amount of time in seconds as a double-precision
floating-point value, store it as the value of this
interval.
secd() -> double
Returns the value of this interval in seconds as
double-precision floating-point value.
- secf(...)
- secf(value)
Given an amount of time in seconds as a single-precision
floating-point value, store it as the value of this interval.
secf() -> float
Returns the value of this interval in seconds as
single-precision floating-point value.
- set(...)
- set(num, timeUnit)
Sets this interval using an integer (num) and a unit type
(timeUnit).
Example: x.set(1, vpr.Interval.Sec)
- setNow(...)
- setNow()
Sets this interval to the current time. This can then be used
to compute a time interval by subtracting two intervals from
each other.
- setNowReal(...)
- setNowReal()
Set now that is gauranteed to be the time based on the system
clock which can then be used to compute a time interval by
subracting two intervals from each other.
- setd(...)
- setd(num, timeUnit)
Sets this interval using a double-precision floating-point
number (num) and a unit type (timeUnit).
Example: x.setd(1.0, vpr.Interval.Sec)
- setf(...)
- setf(num, timeUnit)
Sets this interval using a single-precision floating-point
number (num) and a unit type (timeUnit).
Example: x.setf(1.0, vpr.Interval.Sec)
- usec(...)
- usec(value)
Given an amount of time in microseconds as an integer, store
it as this the value of interval.
usec() -> int
Returns the value of this interval in microseconds as an
integer.
- usecd(...)
- usecd(value)
Given an amount of time in microseconds as a double-precision
floating-point value, store it as this the value of interval.
usecd() -> float
Returns the value of this interval in microseconds as a
double-precision floating-point value.
- usecf(...)
- usecf(value)
Given an amount of time in microseconds as a single-precision
floating-point value, store it as this the value of interval.
usecf() -> float
Returns the value of this interval in microseconds as a
single-precision floating-point value.
Static methods defined here:
- now(...)
- PyJuggler.vpr.Interval.now() -> PyJuggler.vpr.Interval
Helper function that returns an Interval representing the
current time.
Properties defined here:
- HalfPeriod
- get = (...)
- NoTimeout
- get = (...)
- NoWait
- get = (...)
Data and other attributes defined here:
- Unit = <class '__main__.PyJuggler.vpr.Unit'>
- __instance_size__ = 16
- __safe_for_unpickling__ = True
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class ObjectReader(Boost.Python.instance) |
| |
Interface used to read object data from a stream.
ObjectReader and ObjectWriter support an interface that allows for
using tags and attributes in the written output data. This allows
support for formats such as XML where there is a logical grouping
of the data.
The structure looks something like the following (based on XML):
<tag1>
<tag2 attrib1="XXX">
</tag2>
</tag1>
|
| |
- Method resolution order:
- ObjectReader
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- attribExists(...)
- attribExists(name) -> bool
Determines if the named attribute exists.
- beginAttribute(...)
- beginAttribute(attributeName) -> PyJuggler.vpr.ReturnStatus object
Starts an attribute of the name attributeName.
- beginTag(...)
- beginTag(tagName) -> PyJuggler.vpr.ReturnStatus object
Starts a new section/element of name tagName.
- endAttribute(...)
- endAttribute() -> PyJuggler.vpr.ReturnStatus object
Ends the most recently named attribute.
- endTag(...)
- endTag() -> PyJuggler.vpr.ReturnStatus object
Ends the most recently named tag.
- isBinary(...)
- Returns true if the reader is using a binary-based format.
This can be used to choose whether to use human-readable forms
of serialization.
- popState(...)
- pushState()
This allows users to pop the active state of reading. This
is used to move back to the previous reading state.
- pushState(...)
- pushState()
This allows users to push the active state of reading. Later,
this can be used to move back to the previous reading state if
needed.
- readBool(...)
- readDouble(...)
- readFloat(...)
- readString(...)
- readUint16(...)
- readUint32(...)
- readUint64(...)
- readUint8(...)
- resetReading(...)
- resetReading()
Resets the reading to the initial reading state.
<b>Post condition:</b> The reaer can be reused and will
function as if it were just initialized.
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class ObjectWriter(Boost.Python.instance) |
| |
Interface used to write object data to a stream.
ObjectReader and ObjectWriter support an interface that allows for
using tags and attributes in the written output data. This allows
support for formats such as XML where there is a logical grouping
of the data.
The structure looks something like the following (based on XML):
<tag1>
<tag2 attrib1="XXX">
</tag2>
</tag1>
|
| |
- Method resolution order:
- ObjectWriter
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- attribExists(...)
- attribExists(name) -> bool
Determines if the named attribute exists.
- beginAttribute(...)
- beginAttribute(attributeName) -> PyJuggler.vpr.ReturnStatus object
Starts an attribute of the name attributeName.
- beginTag(...)
- beginTag(tagName) -> PyJuggler.vpr.ReturnStatus object
Starts a new section/element of name tagName.
- endAttribute(...)
- endAttribute() -> PyJuggler.vpr.ReturnStatus object
Ends the most recently named attribute.
- endTag(...)
- endTag() -> PyJuggler.vpr.ReturnStatus object
Ends the most recently named tag.
- isBinary(...)
- Returns true if the writer is using a binary-based format.
This can be used to choose whether to use human-readable forms
of serialization.
- writeBool(...)
- writeDouble(...)
- writeFloat(...)
- writeString(...)
- writeUint16(...)
- writeUint32(...)
- writeUint64(...)
- writeUint8(...)
Data and other attributes defined here:
- __init__ = <built-in function __init__>
- Raises an exception
This class cannot be instantiated from Python
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class ReadableObject(Boost.Python.instance) |
| | |
- Method resolution order:
- ReadableObject
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- readObject(...)
- readObject(reader) -> PyJuggler.vpr.ReturnStatus object
Template method for reading into this object from the given
stream.
<b>Post condition:</b> All object data is read from the reader.
Data and other attributes defined here:
- __instance_size__ = 16
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class ReturnStatus(Boost.Python.instance) |
| | |
- Method resolution order:
- ReturnStatus
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __eq__(...)
- __init__(...)
- __ne__(...)
- copy(...)
- failure(...)
- inProgress(...)
- setCode(...)
- success(...)
- timeout(...)
- wouldBlock(...)
Data and other attributes defined here:
- Code = <class '__main__.PyJuggler.vpr.Code'>
- __instance_size__ = 12
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
|
class WriteableObject(Boost.Python.instance) |
| | |
- Method resolution order:
- WriteableObject
- Boost.Python.instance
- __builtin__.object
Methods defined here:
- __init__(...)
- writeObject(...)
- writeObject(writer) -> PyJuggler.vpr.ReturnStatus object
Template method for writing this object to the given stream.
<b>Post condition:</b> All object data is written to the writer.
Data and other attributes defined here:
- __instance_size__ = 16
Data and other attributes inherited from Boost.Python.instance:
- __dict__ = <dictproxy object>
- __new__ = <built-in method __new__ of Boost.Python.class object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
- __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>
| |