BDScalar Class Reference
[BeamDataUtil]

Working base class for BDProcessors that watch a single value. More...

#include <BDScalar.h>

Inheritance diagram for BDScalar:

List of all members.

Public Member Functions
	BDScalar (float max_dev=5.0, int nspills=10, const char *device_name=0)
	~BDScalar ()
void	SetDevice (const char *device_name)
void	SetSpill (const RawBeamMonHeaderBlock &rbmhb, const RawBeamMonBlock &rbmb)
	Set the current spill blocks.
bool	BeamChanged ()
void	SetSpillQueueSize (int nspills)
void	SetAllowedSpillDeviation (float sigmas)
double	GetValue () const
	Return the last scalar added.
Protected Member Functions
virtual double	GetScalar (const RawBeamMonHeaderBlock &rbmhb, const RawBeamMonBlock &rbmb)
Private Attributes
UtilRunningAverage	fPastSpills
float	fMaxDev
bool	fBeamChanged
const char *	fDeviceName

---

Detailed Description

Working base class for BDProcessors that watch a single value.

This maintains a running average of the scalar value. It can be used in two ways:

1) Simply give the constructor a device name and it will use that devices data for the scalar value

2) Subclass and override GetScalar() to handle unpacking/caculating more complex values.

Author:

(last to touch it)

Author

minoscvs

Version:

Revision

1.3

Date:

Date

2005/04/27 17:36:10

Contact: bv@bnl.gov

Created on: Fri Apr 15 09:59:46 2005

Id

BDScalar.h,v 1.3 2005/04/27 17:36:10 minoscvs Exp

Definition at line 37 of file BDScalar.h.

---

Constructor & Destructor Documentation

BDScalar::BDScalar	(	float	max_dev = 5.0,
		int	nspills = 10,
		const char *	device_name = 0
	)

Construct a BDScalar.

Parameters:

	max_dev	maximum number of standard deviations before a change is considered significant.
	nspills	number of spills to average over
	device_name	optionally set a device to watch. See also SetDevice().

Definition at line 8 of file BDScalar.cxx.

References SetSpillQueueSize().

    : fMaxDev(max_dev), fDeviceName(device_name)
{
    this->SetSpillQueueSize(nspills);
}

BDScalar::~BDScalar

(

)

Definition at line 13 of file BDScalar.cxx.

{
}

---

Member Function Documentation

bool BDScalar::BeamChanged

(

)

Return true if the latest spill is a "significant change" from previous as determined by the maximum deviation allowed.

Definition at line 34 of file BDScalar.cxx.

References fBeamChanged.

{
    return fBeamChanged;
}

double BDScalar::GetScalar	(	const RawBeamMonHeaderBlock &	rbmhb,
		const RawBeamMonBlock &	rbmb
	)			[protected, virtual]

Reimplemented in BDHornCurrent.

Definition at line 55 of file BDScalar.cxx.

References fDeviceName, RawBeamData::GetData(), RawBeamData::GetDataLength(), Msg::kWarning, and MSG.

Referenced by SetSpill().

{
    if (!fDeviceName) return 0.0;

    const RawBeamData* dev = rbmb[fDeviceName];
    double value = 0;
    if (!dev) {
        MSG("BD",Msg::kWarning)
        << "No "<<fDeviceName<<" in the data\n";
    }
    else if (! dev->GetDataLength()) {
        MSG("BD",Msg::kWarning)
            << fDeviceName<<" exists but w/out data\n";
    }
    else value = dev->GetData()[0];
    
    return value;
}

double BDScalar::GetValue

(

)

const

Return the last scalar added.

Definition at line 50 of file BDScalar.cxx.

References fPastSpills, and UtilRunningAverage::LastSample().

Referenced by NtpBDFullModule::FillToroids(), BMSpillFiller::Spill(), and BMFileSummaryFiller::Timestamp().

{
    return fPastSpills.LastSample();
}

void BDScalar::SetAllowedSpillDeviation

(

float

sigmas

)

Set the number of standard deviations a toroid measurement is allowed to deviate from the average before it is considered a significant deviation. Deviation is not checked until the configured number of spills have been collected.

Definition at line 45 of file BDScalar.cxx.

References fMaxDev.

{
    fMaxDev = max_dev;
}

void BDScalar::SetDevice

(

const char *

device_name

)

Set device name.

If GetScalar() hasn't been overridden, this device name will be used to pull out data to be used as the watched scalar.

Definition at line 17 of file BDScalar.cxx.

References fDeviceName.

Referenced by BeamMonDbuModule::FillPipeline().

{
    fDeviceName = device_name;
}

void BDScalar::SetSpill	(	const RawBeamMonHeaderBlock &	rbmhb,
		const RawBeamMonBlock &	rbmb
	)			[virtual]

Set the current spill blocks.

Implements BDProcessor.

Definition at line 22 of file BDScalar.cxx.

References UtilRunningAverage::Add(), fBeamChanged, fMaxDev, fPastSpills, GetScalar(), and UtilRunningAverage::SampleDeviation().

Referenced by NtpBDFullModule::FillToroids().

{
    double value = this->GetScalar(rbmhb,rbmb);
    fBeamChanged = false;
    if (fPastSpills.SampleDeviation(value) > fMaxDev)
        fBeamChanged = true;
    
    fPastSpills.Add(value);
    
}

void BDScalar::SetSpillQueueSize

(

int

nspills

)

Set the number of spills overwhich to maintain the running average

Definition at line 40 of file BDScalar.cxx.

References fPastSpills, and UtilRunningAverage::SetSampleSize().

Referenced by BDScalar().

{
    fPastSpills.SetSampleSize(nspills);
}

---

Member Data Documentation

bool BDScalar::fBeamChanged [private]

Definition at line 95 of file BDScalar.h.

Referenced by BeamChanged(), and SetSpill().

const char* BDScalar::fDeviceName [private]

Definition at line 96 of file BDScalar.h.

Referenced by GetScalar(), and SetDevice().

float BDScalar::fMaxDev [private]

Definition at line 94 of file BDScalar.h.

Referenced by SetAllowedSpillDeviation(), and SetSpill().

UtilRunningAverage BDScalar::fPastSpills [private]

Definition at line 93 of file BDScalar.h.

Referenced by GetValue(), SetSpill(), and SetSpillQueueSize().

---

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

• BDScalar.h
• BDScalar.cxx

---