Xpace::Remote::RefList Class Reference

============================= REFERENCE LIST ========== More...

#include <remote.h>

Public Member Functions
void	destroy ()
virtual bool	operator! () const =0
virtual uint64	getCount () const =0
virtual void	getSiblingCount (intArray *atLevel)=0
	return numbers of siblings at levels in the list N.B could be quite slow More...
virtual size_t	getRefs (intArray *ret, uint64 start, uint size=1)=0
	get a range of references More...
virtual void	opAnd (RefList *rhs)=0
	this list AND another list More...
virtual void	opOr (RefList *rhs)=0
	this list OR another list More...
virtual void	opNot ()=0
	invert this list More...
virtual bool	hasRef (const intArray &ref)=0
	does the list contain this ref? N.B. More...

Protected Member Functions
	RefList ()
virtual	~RefList ()

Detailed Description

============================= REFERENCE LIST ==========

Definition at line 78 of file remote.h.

Constructor & Destructor Documentation

Xpace::Remote::RefList::RefList ( )

inlineprotected

Definition at line 143 of file remote.h.

virtual Xpace::Remote::RefList::~RefList ( )

inlineprotectedvirtual

Definition at line 148 of file remote.h.

Member Function Documentation

void Xpace::Remote::RefList::destroy

(

)

virtual bool Xpace::Remote::RefList::operator! ( ) const

pure virtual

Returns

true iff the list is empty

virtual uint64 Xpace::Remote::RefList::getCount ( ) const

pure virtual

Returns

number of refs in the list

virtual void Xpace::Remote::RefList::getSiblingCount ( intArray *  atLevel )

pure virtual

return numbers of siblings at levels in the list N.B could be quite slow

Parameters

atLevel

if (atLevel[n] != 0), count siblings at level n

Return values

atLevel

fill in the number of siblings at level n

Returns

number of distinct siblings in the list

virtual size_t Xpace::Remote::RefList::getRefs ( intArray *  ret, uint64  start, uint  size = 1  )

pure virtual

get a range of references

Return values

ret	array of references

Parameters

start	start of range
size	number of values (e.g., document num, paragraph, sentence) to return for each ref

Returns

number of references (not values) in retval

virtual void Xpace::Remote::RefList::opAnd ( RefList *  rhs )

pure virtual

this list AND another list

Parameters

rhs	the other list

virtual void Xpace::Remote::RefList::opOr ( RefList *  rhs )

pure virtual

this list OR another list

Parameters

rhs	the other list

virtual void Xpace::Remote::RefList::opNot ( )

pure virtual

invert this list

virtual bool Xpace::Remote::RefList::hasRef ( const intArray &  ref )

pure virtual

does the list contain this ref? N.B.

Could be quite slow

Parameters

ref	the reference, e.g. [56789, 2, 1]

Returns

true iff list contains the ref

---

The documentation for this class was generated from the following file:

• remote/remote.h