Module ecto_test¶
ecto.ecto_test¶
SleepPyObjectAbuser¶
Brief doc
Sleep for a bit while in process, according to a list of sleep times.
Parameters
list_o_sleeps
type:boost::python::api::objectnot requiredno default valueA sequence of sleeps.
Inputs
in
type:boost::posix_time::ptimeinput
Outputs
out
type:boost::posix_time::ptimeoutput
Emit_none¶
Brief doc
Emit_none
Outputs
output
type:ecto::tendril::noneoutput
DontAllocateMe¶
Brief doc
Don’t allocate me, feel free to inspect.
Parameters
str
type:std::stringnot requiredno default value
Outputs
str
type:std::string
RequiredIO¶
Brief doc
RequiredIO test module
Inputs
in
type:doublerequired input
Outputs
out
type:doublerequired output
Ping¶
Brief doc
Ping as fast as you can, send the current time downstream
Outputs
out
type:boost::posix_time::ptimeoutput
NoPythonBindings¶
Brief doc
Uses something that is bound to python
Parameters
Woz
type:ecto_test::EvilNoPythonnot requiredno default valueA Woz is a Woz when a Woz was Woz
Outputs
Strasz
type:ecto_test::EvilNoPythonA Strasz is a Strasz when a Strasz saw a Strasz
Emit_float¶
Brief doc
Emit_float
Outputs
output
type:floatoutput
Add¶
Brief doc
Add two doubles together.
Inputs
left
type:doubleLeft hand operand.
right
type:doubleRight hand operand.
Outputs
out
type:doubleThe result.
BreakEveryN¶
Brief doc
Pass on a values but break every Nth iteration.
Parameters
n
type:unsigned longnot requireddefault:1Break on every nth process.
Inputs
in
type:ecto::tendril::noneAny input
Outputs
out
type:ecto::tendril::noneAny input
HandleHolder¶
Brief doc
Holds on to handles...
Parameters
value
type:doublenot requireddefault:1.0I use this value
Inputs
input
type:doubleinput
Outputs
output
type:doubleoutput
value
type:doublethe parameter.
Throttle¶
Brief doc
Throttle to a certain Hz frequency
Parameters
rate
type:doublenot requireddefault:1.0Do not pass data more quickly than this many hz
Inputs
in
type:ecto::tendril::noneinput
Outputs
out
type:ecto::tendril::noneinput
FileI¶
Brief doc
Reads doubles from a file like object
Parameters
file
type:boost::shared_ptr<std::istream>not requiredno default valueA filelike object
Outputs
output
type:doubleA double output.
LatticeSleep¶
Brief doc
Node with N inputs and N outputs, sleeps for a random period on each process()
Parameters
n
type:unsigned intnot requireddefault:1number of ins and outs
Inputs
in0
type:ecto::tendril::noneinput
Outputs
out0
type:ecto::tendril::noneoutput
FileO¶
Brief doc
Writes doubles to a file like object
Parameters
file
type:boost::shared_ptr<std::ostream>not requiredno default valueA filelike object
Inputs
input
type:doubleA double input.
Printer¶
Brief doc
A printer of int, double, string, bool. Use the print_type parameter to specify type. Default is double
Parameters
print_type
type:std::stringnot requireddefault:doubleThe type string for what i’m to print... int, double, bool, string.
Inputs
in
type:doublewhat to print
Metrics¶
Brief doc
Calcluate bandwidth and latency based on timestamps received from an upstream ping.
Parameters
queue_size
type:unsigned intnot requireddefault:10size of window to collect statistics over
Inputs
in
type:boost::posix_time::ptimeinput
Outputs
hz
type:doublelatency_seconds
type:double
Emit_Struct¶
Brief doc
Emit_Struct
Outputs
output
type:ecto_test::Structoutput
Emit_bool¶
Brief doc
Emit_bool
Outputs
output
type:booloutput
Multiply¶
Brief doc
Multiply an input by a constant
Parameters
factor
type:doublenot requireddefault:3.14A factor to multiply by.
Inputs
in
type:doublemultly in by factor
Outputs
out
type:doublethe result of in * factor
ParameterWatcher¶
Brief doc
Uses parameter change callbacks.
Parameters
value
type:doublerequireddefault:1.0I use this value
Inputs
input
type:doubleinput
Outputs
output
type:doubleoutput
value
type:doublethe parameter.
Uniform01¶
Brief doc
Generate random doubles uniformly distributed on [0, 1)
Parameters
ncalls
type:unsigned intnot requireddefault:1Call this many times, return only the last. Used to generate CPU load in testing.
seed
type:unsigned intnot requiredno default valueSeed. By default the RNG is seeded from the system time.
Outputs
out
type:doubleoutput
Gather¶
Brief doc
Gather ints
Parameters
n
type:intnot requireddefault:2N to gather
Inputs
in_0000
type:intAn intinput.
in_0001
type:intAn intinput.
Outputs
out
type:intThe sum of all inputs.
QuitAfter¶
Brief doc
Quits the graph after so many process calls
Parameters
N
type:unsigned intnot requiredno default valueQuit after this many calls to process()
Inputs
in
type:doubleAn inbox
Outputs
out
type:doubleoutbox
Scatter¶
Brief doc
Scatter a value...
Parameters
n
type:intnot requireddefault:2Number to scatter...
x
type:intnot requireddefault:13The value to scatter...
Outputs
out_0000
type:intThe 0th scatter
out_0001
type:intThe 1th scatter
StartStopCounter¶
Brief doc
Count numbers of starts, stops, processes, etc.
Inputs
in
type:ecto::tendril::noneAn inbox
Outputs
nconfigure
type:unsigned intnprocess
type:unsigned intnstart
type:unsigned intnstop
type:unsigned intout
type:ecto::tendril::noneAn inbox
Quitter¶
Brief doc
Will quit the graph on some certain input
Parameters
str
type:std::stringnot requireddefault:EXITThe default string to print
Inputs
str
type:std::stringThe input string to listen to.
Gather_double¶
Brief doc
Gather doubles
Parameters
n
type:intnot requireddefault:2N to gather
Inputs
in_0000
type:doubleAn doubleinput.
in_0001
type:doubleAn doubleinput.
Outputs
out
type:doubleThe sum of all inputs.
Accept_float¶
Brief doc
Accept_float
Inputs
input
type:floatinput
Generate¶
Brief doc
Generate doubles
Parameters
start
type:doublenot requireddefault:0.0My starting value.
step
type:doublenot requireddefault:2.0The step with which i generate integers.
stop
type:doublenot requireddefault:0.0Stop if the generated value exceeds this upper bound (0 implies no upper bound)
Outputs
out
type:doubleThe starting value + (step * iterations).
DontCallMeFromTwoThreads¶
Brief doc
Throws if process called concurrently from two threads.
Inputs
in
type:double
Outputs
out
type:double
Emit_int¶
Brief doc
Emit_int
Outputs
output
type:intoutput
Accept_int¶
Brief doc
Accept_int
Inputs
input
type:intinput
CantCallMeFromTwoThreads¶
Brief doc
Throws if process called concurrently from two threads, but you shouldn’t. be able to provoke this crash because (FIXME)
Inputs
in
type:double
Outputs
out
type:double
Accept_none¶
Brief doc
Accept_none
Inputs
input
type:ecto::tendril::noneinput
DoOverFor¶
Brief doc
Returns ecto::DO_OVER for so many process calls, and returns ecto::OK every current mod N
Parameters
N
type:unsigned intnot requiredno default valueReturn ecto::DO_OVER from process() this many times
Inputs
in
type:doubleAn inbox
Outputs
current
type:unsigned intout
type:doubleoutbox
Accept_bool¶
Brief doc
Accept_bool
Inputs
input
type:boolinput
Accept_string¶
Brief doc
Accept_string
Inputs
input
type:std::stringinput
BpObjectToCellPtr¶
Brief doc
Takes a cell ptr as a bp object.
Inputs
cell
type:boost::python::api::objecta cell ptr
ThrowAfter¶
Brief doc
Throw after so many process calls
Parameters
N
type:unsigned intnot requiredno default valueThrow in the N-th call to process()
Inputs
in
type:doubleAn inbox
Outputs
out
type:doubleoutbox
ExceptInConstructor¶
Brief doc
A bad cell
PassthroughAny¶
Brief doc
Constant node always outputs same value.
Inputs
in
type:ecto::tendril::noneAny type
Outputs
out
type:ecto::tendril::noneAny type
Accumulator¶
Brief doc
Add inputs (potentially from different threads) to an incrementally accumulating sum.
Inputs
left
type:doubleLeft hand operand.
right
type:doubleRight hand operand.
Outputs
out
type:doubleThe current accumulation.
RequiredInput¶
Brief doc
Required input.
Inputs
in
type:doublean input
Outputs
out
type:doubleThe input + x
Accept_Struct¶
Brief doc
Accept_Struct
Inputs
input
type:ecto_test::Structinput
ConfigureCalledOnce¶
Brief doc
Throw’s an error if configure is called more than once.
RequiredParam¶
Brief doc
Required parameter
Parameters
x
type:doublerequiredno default valueA required parameter.
Inputs
in
type:doublean input
Outputs
out
type:doubleThe input + x
Sleep¶
Brief doc
Sleep for a bit while in process
Parameters
seconds
type:doublenot requireddefault:1.0sleep this many seconds
Inputs
in
type:boost::posix_time::ptimeinput
Outputs
out
type:boost::posix_time::ptimeoutput
Increment¶
Brief doc
Increment input by some amount
Parameters
amount
type:doublenot requireddefault:1.0Amount to increment by.
delay
type:unsigned intnot requireddefault:0How long it takes to increment in milliseconds
Inputs
in
type:doubleinput
Outputs
out
type:doubleoutput
Emit_string¶
Brief doc
Emit_string
Outputs
output
type:std::stringoutput