CCamacNimout Class Reference

#include <CCamacNimout.h>

Inheritance diagram for CCamacNimout:

CCamacModule List of all members.

Public Member Functions

 CCamacNimout (unsigned int b, unsigned int c, unsigned int n)
 CCamacNimout (const CCamacNimout &rhs)
 Copy constructor.
 ~CCamacNimout ()
 Destructor.
CCamacNimoutoperator= (const CCamacNimout &rhs)
 Assignment.
int operator== (const CCamacNimout &rhs) const
 Comparison for equality.
int operator!= (const CCamacNimout &rhs) const
unsigned short * getWrite () const
void WriteMask (unsigned short mask)
void WriteBit (unsigned int nBitno)

Private Attributes

unsigned short * m_pWrite
 Pointer to the nimout data register.

Detailed Description

Encapsulates an SEC NIM output register. This module has 12 bits of NIMOUT. The output bits are pulsed when the module is written with an F0.A0. The Module's Write pointer is stored and all members are inline so that this class can be used in timing critical code.

Definition at line 295 of file CCamacNimout.h.


Constructor & Destructor Documentation

CCamacNimout::CCamacNimout ( unsigned int  b,
unsigned int  c,
unsigned int  n 
)

Construct a NIMOUT module located in a particular part of CAMAC space.

Parameters:
b - Branch in which the module lives (if not yet mapped it will be mapped.
c - Crate in which the module lives.
n - Slot in which the module lives.
Exceptions:
CRangeError if the branch crate or slot are bad.
CErrnoException if at some point a system service returned an error.

Definition at line 300 of file CCamacNimout.cpp.

References m_pWrite, and CCamacModule::MakePointer().

CCamacNimout::CCamacNimout ( const CCamacNimout rhs  ) 

Copy constructor.

Copy construction. This is invoked when e.g. an object is passed by value to a function. The copy constructor makes a clone of the rhs object.

Definition at line 314 of file CCamacNimout.cpp.

CCamacNimout::~CCamacNimout (  )  [inline]

Destructor.

Definition at line 307 of file CCamacNimout.h.


Member Function Documentation

CCamacNimout & CCamacNimout::operator= ( const CCamacNimout aCCamacNimout  ) 

Assignment.

Assignment operation. This member function supports assignment of an object of this class to an object of the same class.

Definition at line 325 of file CCamacNimout.cpp.

References m_pWrite, and CCamacModule::operator=().

int CCamacNimout::operator== ( const CCamacNimout rhs  )  const

Comparison for equality.

Equality comparison.

Definition at line 338 of file CCamacNimout.cpp.

References m_pWrite.

Referenced by operator!=().

int CCamacNimout::operator!= ( const CCamacNimout rhs  )  const [inline]

Definition at line 311 of file CCamacNimout.h.

References operator==().

unsigned short* CCamacNimout::getWrite (  )  const [inline]

Definition at line 318 of file CCamacNimout.h.

References m_pWrite.

void CCamacNimout::WriteMask ( unsigned short  mask  ) 

Writes a mask of data to the NIMOUT. All of the bits in the mask will be strobed simultaneously.

Parameters:
mask - The mask of bits to strobe. Note that only bits below bit 12 (from 0) mean anything.
unsigned short mask

Definition at line 357 of file CCamacNimout.cpp.

References m_pWrite.

Referenced by CCAMACStatusModule::ModuleClear().

void CCamacNimout::WriteBit ( unsigned int  nBitno  ) 

Strobes a single bit of output.

Parameters:
nBitno - The bit to strobe numbered from 0. Any value of 12 or above results in a no-op.
unsigned int nBitno

Definition at line 371 of file CCamacNimout.cpp.

References m_pWrite.

Referenced by CCAMACStatusModule::GoBusy(), and CCAMACStatusModule::GoClear().


Member Data Documentation

unsigned short* CCamacNimout::m_pWrite [private]

Pointer to the nimout data register.

Definition at line 298 of file CCamacNimout.h.

Referenced by CCamacNimout(), getWrite(), operator=(), operator==(), WriteBit(), and WriteMask().


The documentation for this class was generated from the following files:
Generated on Wed Sep 17 08:38:11 2008 for NSCL Device support. by  doxygen 1.5.1