OSWcontributionIterator Class Reference

Class for iterating over contributions to an OSW (Online SoftWare) contribution. More...

#include <OSWcontributionIterator.h>

Collaboration diagram for OSWcontributionIterator:

[legend]List of all members.

Public Member Functions
	OSWcontributionIterator (EBFevent *event, OSWcontribution *contribution)
	Constructor for iterating over an Online Software contribution.
	OSWcontributionIterator ()
	Do nothing constructor.
virtual int	handleError (OSWcontribution *contribution, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in OSWcontributionIterator.
unsigned	iterate ()
	Iterate over the contributions in an OSWcontribution.
unsigned	iterate (EBFevent *event, OSWcontribution *contribution)
	Iterate over the contributions in an OSWcontribution.
virtual int	OSWtime (const struct timespec *ts, const OSWtimeBase *tb) const
	Virtual method for calling the application back with time data.
virtual int	OSW_time (EBFevent *event, OSWtimeContribution *contribution) const
	Virtual method for calling the application back with the time contribution.
virtual int	OSW_UDF (EBFevent *event, OSWcontribution *contribution) const
	Undefined Online Software contribution handler.
const EBFevent *	event () const
const OSWcontribution *	contribution () const
int	status () const

---

Detailed Description

Class for iterating over contributions to an OSW (Online SoftWare) contribution.

Author:

R. Claus -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)

Revision

1.5

Date:

February 25, 2004 -- Created

Id

OSWcontributionIterator.h,v 1.5 2005/03/31 00:39:31 claus Exp

Copyright: Copyright 2004 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved.

---

Constructor & Destructor Documentation

OSWcontributionIterator::OSWcontributionIterator	(	EBFevent *	event,
		OSWcontribution *	contribution
	)			[inline]

Constructor for iterating over an Online Software contribution.

This constructor caches the event and contribution provided by the caller.

Parameters:

	event	A pointer to the EBFevent containing the contribution
	contribution	A pointer to the contribution to iterate over

---

Member Function Documentation

const OSWcontribution * OSWcontributionIterator::contribution

(

)

const [inline]

Return a pointer to the OSWcontribution to be iterated over

const EBFevent * OSWcontributionIterator::event

(

)

const [inline]

Return a pointer to the EBFevent containing this contribution

int OSWcontributionIterator::handleError	(	OSWcontribution *	contribution,
		unsigned	code,
		unsigned	p1 = 0,
		unsigned	p2 = 0
	)			const [inline, virtual]

Handle all errors possible in OSWcontributionIterator.

This method is used to handle errors occurring during the iteration over an OSWcontribution. By default it does nothing, however it is virtual and is able to be overridden by the user.

Parameters:

	contribution	The contribution in error
	code	The error code
	p1	a parameter associated with the error code
	p2	a parameter associated with the error code

unsigned OSWcontributionIterator::iterate	(	EBFevent *	event,
		OSWcontribution *	contribution
	)

Iterate over the contributions in an OSWcontribution.

Parameters:

	event	- The EBFevent containing the OSWcontribution
	contribution	- The OSWcontribution to be iterated over

Returns:

The number of contributions treated

unsigned OSWcontributionIterator::iterate

(

)

[inline]

Iterate over the contributions in an OSWcontribution.

Returns:

The number of contributions treated

int OSWcontributionIterator::OSW_time	(	EBFevent *	event,
		OSWtimeContribution *	contribution
	)			const [inline, virtual]

Virtual method for calling the application back with the time contribution.

The default implementation of this method calls the OSWtime pure virtual method. This is done to preserve the historical interface.

Parameters:

	event	- A pointer to the EBFevent containing the contribution
	contribution	- A pointer to an OSWtimeContribution

Returns:

A status code

int OSWcontributionIterator::OSW_UDF	(	EBFevent *	event,
		OSWcontribution *	contribution
	)			const [inline, virtual]

Undefined Online Software contribution handler.

Parameters:

	event	- A pointer to the event containing the contribution
	contribution	- A pointer to the contribution being iterated over

Returns:

A status code

int OSWcontributionIterator::OSWtime	(	const struct timespec *	ts,
		const OSWtimeBase *	tb
	)			const [inline, virtual]

Virtual method for calling the application back with time data.

Parameters:

	ts	- A pointer to a timespec structure containing the event timestamp
	tb	- A pointer to an OSWtimeBase containing the event timebase value

Returns:

A status code

int OSWcontributionIterator::status

(

)

const [inline]

Return the iteration status code

---

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

• OSWcontributionIterator.h
• OSWcontributionIterator.cpp

---