LbmUnionExecStreamParams Struct Reference

LbmUnionExecStreamParams defines parameters for instantiating a LbmUnionExecStream. More...

#include <LbmUnionExecStream.h>

Inheritance diagram for LbmUnionExecStreamParams:

ConfluenceExecStreamParams SingleOutputExecStreamParams ExecStreamParams List of all members.

Public Attributes

LcsRid maxRid
 Maximum rid of the table being processed.
DynamicParamId ridLimitParamId
 Parameter id for the dynamic parameter used to limit the number of rids that should appear in an input tuple.
DynamicParamId startRidParamId
 Parameter id for the dynamic parameter used to request filtering of rids output.
DynamicParamId segmentLimitParamId
 Parameter id for the dynamic parameter used to limit the number of segments this stream should produce on a single execute.

Detailed Description

LbmUnionExecStreamParams defines parameters for instantiating a LbmUnionExecStream.

Definition at line 38 of file LbmUnionExecStream.h.


Member Data Documentation

LcsRid LbmUnionExecStreamParams::maxRid

Maximum rid of the table being processed.

Definition at line 43 of file LbmUnionExecStream.h.

Referenced by LbmUnionExecStream::prepare(), LbmUnionExecStreamTest::testUnion(), and ExecStreamSubFactory_lu::visit().

DynamicParamId LbmUnionExecStreamParams::ridLimitParamId

Parameter id for the dynamic parameter used to limit the number of rids that should appear in an input tuple.

Producers for this stream should respect the limitation.

This parameter is set by the union stream during open.

Definition at line 52 of file LbmUnionExecStream.h.

Referenced by LbmUnionExecStream::prepare(), LbmUnionExecStreamTest::testUnion(), and ExecStreamSubFactory_lu::visit().

DynamicParamId LbmUnionExecStreamParams::startRidParamId

Parameter id for the dynamic parameter used to request filtering of rids output.

This dynamic parameter may be set by consumers.

This parameter is optional and is read during execute. If not used, this parameter should be set to zero.

Definition at line 61 of file LbmUnionExecStream.h.

Referenced by LbmUnionExecStream::prepare(), LbmUnionExecStreamTest::testUnion(), and ExecStreamSubFactory_lu::visit().

DynamicParamId LbmUnionExecStreamParams::segmentLimitParamId

Parameter id for the dynamic parameter used to limit the number of segments this stream should produce on a single execute.

May be set by consumers.

This parameter is optional and is read during execute. If not used, this parameter should be set to zero.

Definition at line 71 of file LbmUnionExecStream.h.

Referenced by LbmUnionExecStream::prepare(), LbmUnionExecStreamTest::testUnion(), and ExecStreamSubFactory_lu::visit().


The documentation for this struct was generated from the following file:
Generated on Mon Jun 22 04:00:36 2009 for Fennel by  doxygen 1.5.1