ICP  1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
EnvironmentCard< EnvPeriodPolicy > Class Template Reference

#include <environment_card.h>

Inheritance diagram for EnvironmentCard< EnvPeriodPolicy >:
Inheritance graph

Public Member Functions

int startRun (DAEstatus &status)
 
int stopRun (DAEstatus &status)
 
int ClearFramesAndPPP (DAEstatus &status)
 
int setFrameSync (FrameSync fs, DAEstatus &status)
 
bool isRunning (DAEstatus &status)
 
void printStatus (std::ostream &os, DAEstatus &status)
 
int resetRunController (DAEstatus &status)
 
int getRawFrames (isisU32_t *value, DAEstatus &status)
 
int getGoodFrames (isisU32_t *value, DAEstatus &status)
 
int getRawPPPLower (isisU32_t *value, DAEstatus &status)
 
int getRawPPPUpper (isisU32_t *value, DAEstatus &status)
 
int getRawPPP (isisU64_t *value, DAEstatus &status)
 
int getGoodPPPLower (isisU32_t *value, DAEstatus &status)
 
int getGoodPPPUpper (isisU32_t *value, DAEstatus &status)
 
int getGoodPPP (isisU64_t *value, DAEstatus &status)
 
int enableSMPVeto (DAEstatus &status)
 
int enableTS2PulseVeto (DAEstatus &status)
 
int enableISIS50HzVeto (DAEstatus &status)
 
int enableExternalVeto (int veto_number, DAEstatus &status)
 
int enableInternalVeto (DAEstatus &status)
 
int enableFIFOVeto (DAEstatus &status)
 
int enableHardwarePeriods (DAEstatus &status)
 
int disableHardwarePeriods (DAEstatus &status)
 
int disableSMPVeto (DAEstatus &status)
 
int disableExternalVeto (int veto_number, DAEstatus &status)
 
int disableInternalVeto (DAEstatus &status)
 
int disableFIFOVeto (DAEstatus &status)
 
int disableTS2PulseVeto (DAEstatus &status)
 
int disableISIS50HzVeto (DAEstatus &status)
 
int getSMPVetoedFrames (isisU32_t *value, DAEstatus &status)
 
int getExternalVetoedFrames (int veto_number, isisU32_t *value, DAEstatus &status)
 
int getFIFOVetoedFrames (isisU32_t *value, DAEstatus &status)
 
int getTS2PulseVetoedFrames (isisU32_t *value, DAEstatus &status)
 
int getISIS50HzVetoedFrames (isisU32_t *value, DAEstatus &status)
 
int clearSMPVetoedFrames (DAEstatus &status)
 
int clearExternalVetoedFrames (DAEstatus &status)
 
int clearFIFOVetoedFrames (DAEstatus &status)
 
int setFrameSyncDelay (isisU32_t value, DAEstatus &status)
 
int getFrameSyncDelay (isisU32_t *value, DAEstatus &status)
 
float getRawUAmpHours (DAEstatus &status)
 
float getGoodUAmpHours (DAEstatus &status)
 
bool usingHardwarePeriods (DAEstatus &status)
 
 EnvironmentCard (int position, ISISVME *vme, DAEstatus &status)
 
int getFChopperVetoedFrames (int chopper_number, isisU32_t *value, DAEstatus &status)
 
int enableFChopperVeto (int chopper_number, int delay, int width, DAEstatus &status)
 
int disableFChopperVeto (int chopper_number, DAEstatus &status)
 
int printVetoDetails (std::ostream &os, DAEstatus &status)
 
int whichVeto (std::ostream &os, DAEstatus &status)
 
virtual int resetCardState (DAEstatus &status)
 
virtual int position () const
 
virtual std::string daeDevice () const
 
- Public Member Functions inherited from DAE2Card< EnvPeriodPolicy >
 DAE2Card (int position, ISISVME *vme, DAEstatus &status)
 
int setRegisterBits (unsigned long address, isisU32_t mask, bool preserve, DAEstatus &status, bool little_endian=false)
 
int clearRegisterBits (unsigned long address, isisU32_t mask, DAEstatus &status, bool little_endian=false)
 
int setAndClearRegisterBits (unsigned long address, isisU32_t mask, bool preserve, DAEstatus &status, bool little_endian=false)
 
int setAndClearRegisterBits (const unused_t &address, isisU32_t mask, bool preserve, DAEstatus &status, bool little_endian=false)
 
int changeRegisterBits (unsigned long address, isisU32_t mask, bool set, bool check, DAEstatus &status, bool little_endian=false)
 
bool registerBitsSet (unsigned long address, isisU32_t mask, DAEstatus &status, bool little_endian=false)
 
bool registerBitsClear (unsigned long address, isisU32_t mask, DAEstatus &status, bool little_endian=false)
 
int readRegister (unsigned long address, isisU32_t *value, DAEstatus &status, bool little_endian=false, bool retry=true)
 
int readRegister (unsigned long address, isisU16_t *value, DAEstatus &status, bool little_endian=false, bool retry=true)
 
int readRegister (const unused_t &address, isisU32_t *value, DAEstatus &status, bool little_endian=false, bool retry=true)
 
int writeRegister (unsigned long address, isisU32_t value, DAEstatus &status, bool little_endian=false)
 
int writeRegister (const unused_t &address, isisU32_t value, DAEstatus &status, bool little_endian=false)
 
int writeRegister16 (unsigned long address, isisU16_t value, DAEstatus &status, bool little_endian=false)
 
int writeRegister16 (const unused_t &address, isisU16_t value, DAEstatus &status, bool little_endian=false)
 
int readRegister16As32 (unsigned long address0, unsigned long address1, isisU32_t *value, DAEstatus &status, bool little_endian=false)
 
int writeRegister32As16 (unsigned long address0, unsigned long address1, isisU32_t value, DAEstatus &status, bool little_endian=false)
 
int position () const
 
std::string daeDevice () const
 
std::string getFirmwareVersionAsString (DAEstatus &status)
 
virtual ~DAE2Card ()
 
void printRegister (const char *name, unsigned long address, std::ostream &os, bool print_bits_set=false)
 
int readMemory (unsigned long address, typename T *buffer, int len, ISISVME::TransferProps props, DAEstatus &status)
 
int readMemoryChunked (unsigned long address, T *buffer, int len, int chunk_len, ISISVME::TransferProps props, DAEstatus &status)
 
int writeMemory (unsigned long address, T *buffer, int len, uint64_t read_check_mask, ISISVME::TransferProps props, DAEstatus &status)
 
int zeroMemory (unsigned long start, int len, uint64_t read_check_mask, ISISVME::TransferProps props, DAEstatus &status)
 
- Public Member Functions inherited from DAE2CardIntf
 DAE2CardIntf ()
 
virtual ~DAE2CardIntf ()
 
- Public Member Functions inherited from EnvironmentCardIntf
 EnvironmentCardIntf ()
 
virtual ~EnvironmentCardIntf ()
 

Protected Types

enum  EnvironmentCardOptions { None =0x0, FChopperVeto =0x1 }
 

Protected Member Functions

int setVetoRegisterBits (isisU32_t mask, bool preserve, DAEstatus &status)
 
int clearVetoRegisterBits (isisU32_t mask, DAEstatus &status)
 
int setRunControlBits (isisU32_t mask, bool preserve, DAEstatus &status)
 
int clearRunControlBits (isisU32_t mask, DAEstatus &status)
 
int setAndClearRunControlBits (isisU32_t mask, bool preserve, DAEstatus &status)
 
int clearPPP (DAEstatus &status)
 
- Protected Member Functions inherited from DAE2Card< EnvPeriodPolicy >
virtual unsigned long makeAddress (unsigned long address)
 
void reverseEndian (isisU32_t *value)
 
void reverseEndian (isisU16_t *value)
 
std::string loggingPrefix () const
 
- Protected Member Functions inherited from ISIS::Base
 Base (const std::string &logger_name="UNKNOWN")
 
void setLoggerName (const std::string &logger_name)
 
virtual ~Base ()
 
void setThisLoggerLevel (int level)
 

Protected Attributes

CardOptions m_options
 
- Protected Attributes inherited from DAE2Card< EnvPeriodPolicy >
int m_position
 
ISISVMEm_vme
 
- Protected Attributes inherited from ISIS::Base
Poco::Logger * m_logger
 
Poco::LogStream * m_logstr
 
Poco::Mutex m_logger_lock
 

Additional Inherited Members

- Public Types inherited from DAE2CardIntf
enum  CardType {
  EmptySlot = 0, UnknownCard = 1, EnvCard = 2, EnvPeriodCard = 3,
  NeutronDetectorCard = 4, MuonDetectorCard = 5, MuonPeriodCard = 6
}
 
- Static Public Member Functions inherited from DAE2Card< EnvPeriodPolicy >
static bool isCardPresent (int position, ISISVME *vme, DAEstatus &status)
 
static CardType getCardType (int position, ISISVME *vme, DAEstatus &dstatus)
 
static unsigned long makeAddress (int position, unsigned long address)
 
- Static Protected Member Functions inherited from DAE2Card< EnvPeriodPolicy >
static int getFirmwareVersion (int position, ISISVME *vme, firmware_version *fw, DAEstatus &status)
 
static const char * yesNoStr (bool b)
 
- Static Protected Member Functions inherited from ISIS::Base
static void setAllLoggerLevel (int level)
 

Detailed Description

template<class EnvPeriodPolicy>
class EnvironmentCard< EnvPeriodPolicy >

Definition at line 69 of file environment_card.h.

Member Enumeration Documentation

template<class EnvPeriodPolicy >
enum EnvironmentCard::EnvironmentCardOptions
protected
Enumerator
None 
FChopperVeto 

Definition at line 133 of file environment_card.h.

Constructor & Destructor Documentation

template<class EnvPeriodPolicy >
EnvironmentCard< EnvPeriodPolicy >::EnvironmentCard ( int  position,
ISISVME vme,
DAEstatus status 
)

Member Function Documentation

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::clearExternalVetoedFrames ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 394 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::clearFIFOVetoedFrames ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 402 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::ClearFramesAndPPP ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 54 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::clearPPP ( DAEstatus status)
protected

Definition at line 63 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::clearRunControlBits ( isisU32_t  mask,
DAEstatus status 
)
protected

Definition at line 28 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::clearSMPVetoedFrames ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 386 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::clearVetoRegisterBits ( isisU32_t  mask,
DAEstatus status 
)
protected

Definition at line 546 of file environment_card.cpp.

template<class EnvPeriodPolicy >
virtual std::string EnvironmentCard< EnvPeriodPolicy >::daeDevice ( ) const
inlinevirtual

Implements DAE2CardIntf.

Definition at line 130 of file environment_card.h.

References DAE2Card< DAECardPolicy >::daeDevice().

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableExternalVeto ( int  veto_number,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 289 of file environment_card.cpp.

References DAEstatus::addWarningVa(), FAC_DAE, and DAEstatus::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableFChopperVeto ( int  chopper_number,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 514 of file environment_card.cpp.

References DAEstatus::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableFIFOVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 319 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableHardwarePeriods ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 440 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableInternalVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 313 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableISIS50HzVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 331 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableSMPVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 283 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::disableTS2PulseVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 325 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableExternalVeto ( int  veto_number,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 235 of file environment_card.cpp.

References DAEstatus::addWarningVa(), FAC_DAE, and DAEstatus::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableFChopperVeto ( int  chopper_number,
int  delay,
int  width,
DAEstatus status 
)
virtual
template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableFIFOVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 265 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableHardwarePeriods ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 434 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableInternalVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 259 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableISIS50HzVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 277 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableSMPVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 229 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::enableTS2PulseVeto ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 271 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getExternalVetoedFrames ( int  veto_number,
isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 343 of file environment_card.cpp.

References DAEstatus::addWarningVa(), FAC_DAE, and DAEstatus::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getFChopperVetoedFrames ( int  chopper_number,
isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 528 of file environment_card.cpp.

References DAEstatus::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getFIFOVetoedFrames ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 368 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getFrameSyncDelay ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 428 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getGoodFrames ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 166 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getGoodPPP ( isisU64_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 213 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getGoodPPPLower ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 198 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getGoodPPPUpper ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 204 of file environment_card.cpp.

template<class EnvPeriodPolicy >
float EnvironmentCard< EnvPeriodPolicy >::getGoodUAmpHours ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 470 of file environment_card.cpp.

References PPP_TO_UAMPH.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getISIS50HzVetoedFrames ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 380 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getRawFrames ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 148 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getRawPPP ( isisU64_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 187 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getRawPPPLower ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 172 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getRawPPPUpper ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 178 of file environment_card.cpp.

template<class EnvPeriodPolicy >
float EnvironmentCard< EnvPeriodPolicy >::getRawUAmpHours ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 481 of file environment_card.cpp.

References PPP_TO_UAMPH.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getSMPVetoedFrames ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 337 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::getTS2PulseVetoedFrames ( isisU32_t value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 374 of file environment_card.cpp.

template<class EnvPeriodPolicy >
bool EnvironmentCard< EnvPeriodPolicy >::isRunning ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 98 of file environment_card.cpp.

template<class EnvPeriodPolicy >
virtual int EnvironmentCard< EnvPeriodPolicy >::position ( ) const
inlinevirtual

Implements DAE2CardIntf.

Definition at line 129 of file environment_card.h.

References DAE2Card< DAECardPolicy >::position().

template<class EnvPeriodPolicy >
void EnvironmentCard< EnvPeriodPolicy >::printStatus ( std::ostream &  os,
DAEstatus status 
)
virtual
template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::printVetoDetails ( std::ostream &  os,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 552 of file environment_card.cpp.

References DAEstatus::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::resetCardState ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 632 of file environment_card.cpp.

References LOGSTR_INFORMATION, and ISISVME::Success.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::resetRunController ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 223 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::setAndClearRunControlBits ( isisU32_t  mask,
bool  preserve,
DAEstatus status 
)
protected

Definition at line 34 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::setFrameSync ( FrameSync  fs,
DAEstatus status 
)
virtual
template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::setFrameSyncDelay ( isisU32_t  value,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 410 of file environment_card.cpp.

References DAEstatus::add(), ERRTYPE_INVCARD, FAC_ENVCARD, and SEV_ERROR.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::setRunControlBits ( isisU32_t  mask,
bool  preserve,
DAEstatus status 
)
protected

Definition at line 22 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::setVetoRegisterBits ( isisU32_t  mask,
bool  preserve,
DAEstatus status 
)
protected

Definition at line 540 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::startRun ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 40 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::stopRun ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 47 of file environment_card.cpp.

template<class EnvPeriodPolicy >
bool EnvironmentCard< EnvPeriodPolicy >::usingHardwarePeriods ( DAEstatus status)
virtual

Implements EnvironmentCardIntf.

Definition at line 446 of file environment_card.cpp.

template<class EnvPeriodPolicy >
int EnvironmentCard< EnvPeriodPolicy >::whichVeto ( std::ostream &  os,
DAEstatus status 
)
virtual

Implements EnvironmentCardIntf.

Definition at line 569 of file environment_card.cpp.

References DAEstatus::Success.

Member Data Documentation

template<class EnvPeriodPolicy >
CardOptions EnvironmentCard< EnvPeriodPolicy >::m_options
protected

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