---

CNSCLControlBuffer Class Reference

#include <CNSCLControlBuffer.h>

Inheritance diagram for CNSCLControlBuffer:

List of all members.

Public Methods
	CNSCLControlBuffer (unsigned int nWords=4096)
	Default constructor.
	~CNSCLControlBuffer ()
	Destructor.
void	PutTitle (const string &rTitle)
void	PutTimeOffset (unsigned long nTime)
Protected Methods
void	SetTime ()
Private Methods
	CNSCLControlBuffer (const CNSCLControlBuffer &rhs)
	Copy constructor.
CNSCLControlBuffer &	operator= (const CNSCLControlBuffer &rhs)
	Assignment.
int	operator== (const CNSCLControlBuffer &rhs) const
	Comparison for equality.
int	operator!= (const CNSCLControlBuffer &rhs)

---

Detailed Description

Encapsulates the formatting of a control buffer. Control buffers are placed in the run data stream to indicate run state changes. These include:

• Begin - run starts.
• End - Run ends.
• Pause - Run paused.
• Resume - Run resumed.

These buffers are distinguishable from each other by their buffer type. Other than that, these buffers all have the same set of common elements:

• Buffer header.
• Time of event relative to run start.
• Absolute date and time of event.
• Title of run (79 characters with null terminator).

Note:

The number of entities in a control buffer is always zero.

Definition at line 315 of file CNSCLControlBuffer.h.

---

Constructor & Destructor Documentation

CNSCLControlBuffer::CNSCLControlBuffer (  unsigned int    nWords = 4096 )

Default constructor. Default constructor. This is called when declarations of the form e.g.: CNSCLControlBuffer object; are performed. Definition at line 295 of file CNSCLControlBuffer.cpp. References CNSCLOutputBuffer::getBuffer(), CNSCLOutputBuffer::m_ControlTag, and SetTime().

CNSCLControlBuffer::~CNSCLControlBuffer (    )  [inline]

Destructor. Definition at line 323 of file CNSCLControlBuffer.h.

CNSCLControlBuffer::CNSCLControlBuffer (  const CNSCLControlBuffer &    rhs )  [private]

Copy constructor.

---

Member Function Documentation

int CNSCLControlBuffer::operator!= (  const CNSCLControlBuffer &    rhs )  [private]

CNSCLControlBuffer& CNSCLControlBuffer::operator= (  const CNSCLControlBuffer &    rhs )  [private]

Assignment.

int CNSCLControlBuffer::operator== (  const CNSCLControlBuffer &    rhs )  const [private]

Comparison for equality.

void CNSCLControlBuffer::PutTimeOffset (  unsigned long    nTime )

Sets the time offset field in 10'ths of a second from the run start. Parameters: nTime  - longword time offset. unsigned  long nTime Definition at line 334 of file CNSCLControlBuffer.cpp. References offLTIME, CNSCLOutputBuffer::PutLong(), and CNSCLOutputBuffer::Seek(). Referenced by CNSCLBeginBuffer::CNSCLBeginBuffer(), CExperiment::EmitEnd(), CExperiment::EmitPause(), CExperiment::EmitResume(), and CExperiment::EmitStart().

void CNSCLControlBuffer::PutTitle (  const string &    rTitle )

Puts the title string in the buffer: If the title string is less than 79 characters it is null padded. If the title string is more than 79 characters it is truncated. The 80'th character of the title string will always be a null ensuring the title can be used as a C Null terminated string. Parameters: const  string& rTitle. Definition at line 319 of file CNSCLControlBuffer.cpp. References offBTITLE, CNSCLOutputBuffer::PutString(), and CNSCLOutputBuffer::Seek(). Referenced by CExperiment::EmitEnd(), CExperiment::EmitPause(), CExperiment::EmitResume(), and CExperiment::EmitStart().

void CNSCLControlBuffer::SetTime (    )  [protected]

Put the current time in the buffer in NSCL DAQ format. Definition at line 343 of file CNSCLControlBuffer.cpp. References offSBFTIME, CNSCLOutputBuffer::PutWord(), and CNSCLOutputBuffer::Seek(). Referenced by CNSCLControlBuffer().

---

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

• CNSCLControlBuffer.h
• CNSCLControlBuffer.cpp

---