NSCL DDAS 12.2-009
Support for XIA DDAS at FRIB
Public Types | Public Member Functions | List of all members
DAQ::DDAS::SystemBooter Class Reference

Manages the booting process for DDAS. More...

#include <SystemBooter.h>

Public Types

enum  BootType { FullBoot , SettingsOnly }
 An enum for boot type masks, legacy flags. More...
 

Public Member Functions

 SystemBooter ()
 Constructor. More...
 
void boot (Configuration &config, BootType type)
 Boot the entire system. More...
 
void setVerbose (bool enb)
 Enable or disable verbose output. More...
 
bool isVerbose () const
 Return the verbose state. More...
 
void setOfflineMode (unsigned short mode)
 Enable or disable online boot. More...
 
unsigned short getOfflineMode () const
 Return the boot mode of the system. More...
 

Detailed Description

Manages the booting process for DDAS.

All Readout and slow controls programs rely on this class to boot the system.

Member Enumeration Documentation

◆ BootType

An enum for boot type masks, legacy flags.

Enumerator
FullBoot 

Full boot with firmware load.

SettingsOnly 

Boot with settings only.

Constructor & Destructor Documentation

◆ SystemBooter()

DAQ::DDAS::SystemBooter::SystemBooter ( )

Constructor.

Default settings: verbose output enabled, boot in online mode.

Member Function Documentation

◆ boot()

void DAQ::DDAS::SystemBooter::boot ( Configuration config,
BootType  type 
)

Boot the entire system.

Parameters
configReferences the system configuration.
typeBoot type (full or settings-only).

Perform parallel boot of DDAS crate. Offline mode supported as of XIA API 4.4.0.

◆ getOfflineMode()

unsigned short DAQ::DDAS::SystemBooter::getOfflineMode ( ) const
inline

Return the boot mode of the system.

Returns
Boot mode: 0 for online, anything else for offline.

◆ isVerbose()

bool DAQ::DDAS::SystemBooter::isVerbose ( ) const
inline

Return the verbose state.

Returns
True if verbose output enabled, false otherwise.

◆ setOfflineMode()

void DAQ::DDAS::SystemBooter::setOfflineMode ( unsigned short  mode)
inline

Enable or disable online boot.

Parameters
modeBoot mode: 0 for online, anything else (typically 1) for offline.

◆ setVerbose()

void DAQ::DDAS::SystemBooter::setVerbose ( bool  enb)
inline

Enable or disable verbose output.

Parameters
enbEnables output messages if true.

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