ifw-daq
2.1.0-pre1
IFW Data Acquisition modules
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level
1
2
3
4
5
]
►
N
conf
C
Internal
►
N
daq
►
N
config
►
C
Manager
Maintains the associativity of configuration attributes with metadata and value origin/priority
C
CurrentValue
Describes current value
C
Metadata
Immutable information about a configuration attribute
C
OriginInfo
Mutable metadata about a configuration attribute that describes where a value comes from
►
N
dpm
►
N
detail
C
Rule
Represents a keyword rule expression
►
N
merge
►
N
base
C
FitsFile
C
KeywordRules
Represents the keyword rules from the Data Product Specification
C
Source
Base source
C
FitsFileSource
Input FITS source file
C
FitsKeywordsSource
Input FITS keywords
C
Formatter
C
JsonReporter
Reports in JSON format
C
KeywordFilter
Interface to a keyword selector
C
KeywordFormatter
C
KeywordSorter
C
KeywordTransform
C
MergeEvent
Base class of merge events
C
MockFormatter
C
MockKeywordProcessor
C
MockReporter
C
MockSorter
C
Operations
C
Params
C
SimpleReporter
Reports in unspecified human-readable format
C
Sorter
C
SourceNotFoundError
Source
file not found
C
StatusReporter
Interface to reporter (implementations exist for JSON or human readable)
C
TargetSource
Target FITS file
C
TestMergeKeywords
Fixture that sets up a in-place target FITS file with standard HDU keywords
►
N
message
C
BaseAlert
C
BaseMessage
C
KeywordAlert
C
ConcurrencyLimits
Imposes limits on how many concurrent operations are allowed
C
ConfigManager
DPM Server specific configuration manager
C
Configuration
Represents active configuration
C
DaqController
Controller for specific DAQ
C
DaqControllerImpl
Internal data structure to
SchedulerImpl
C
DaqControllerOptions
Options for
DaqController
C
DaqWorkspace
Interface to DAQ workpace (TBD)
C
DaqWorkspaceImpl
C
DpmService
Daqif::DpmControl and DpmDaqControl implementation
C
FakeDaqControllerFactory
C
FakeProcFactory
C
FakeRsyncFactory
C
KeywordEx
Create keyword expression that memoize the provided string pattern
C
KeywordRuleProcessor
Interface for keyword rule processors
C
MockDaqController
C
MockDaqWorkspace
C
MockScheduler
C
MockWorkspace
C
Resource
C
Resources
Limited resources
C
ResourceToken
RAII token
C
Scheduler
Schedules asynchronous activities that results in merged Data Product and delivery
C
SchedulerImpl
►
C
SchedulerOptions
Options controlling scheduler operations
C
ConcurrencyLimits
Imposes limits on how many concurrent operations are allowed
C
SourceNotFound
►
C
SourceResolver
Provides location of fits source file
C
SourceFile
C
StandardKeywordRuleProcessor
C
TestDaqController
C
TestDaqControllerBase
C
TestDaqControllerInit
C
TestDpmService
C
TestKeywordMatch
C
TestKeywordMatchP
C
TestKeywordTransform
C
TestParseDpSpec
C
TestParseOrigin
C
TestScheduler
C
TestSchedulerBase
C
TestSchedulerInit
C
Workspace
Interface to interact with DPM workspace
C
WorkspaceImpl
Implementation of
daq::dpm::Workspace
►
N
error
C
NestedExceptionReporter
Adapter object intended to be used in contexts without direct access to the output-stream object
►
N
fits
►
N
v1
Versioned namespace of sorting functions in case standard evolves but instruments want to freeze
C
StandardLess
Sorting function object
C
BasicKeyword
A type safe version of
LiteralKeyword
that consist of the three basic components of a FITS keyword keyword record: name, value and optional comment
C
BasicKeywordBase
Non template base class that is purely used to avoid type-deduction issues of ValueType
C
CfitsioError
Represents errors from cfitsio
C
EsoKeywordTraits
C
KeywordNameView
►
C
LiteralKeyword
Represents the literal 80-character FITS keyword record
C
Components
Decomposed components a literal keyword
C
MemoryFitsFile
In-memory FITS file
C
ValueKeywordTraits
►
N
op
C
AbortAsync
A composite async operation that aborts a DAQ
C
AlertState
C
AsyncOpParams
Parameters required for each async operation
C
AwaitOpParams
Await specific parameters that is not provided with
AsyncOpParams
C
AwaitPrimAsync
A composite async operation that awaits primary data sources
C
AwaitStateAsync
Async operation to await Data Acquisition state
C
OpStat
Keeps record when operation started and finished
C
StartAsync
A composite async operation that starts DAQ
C
StopAsync
A composite async operation that starts DAQ
C
ActionEvent
Event related to an action being requested or performed
C
Alert
Describes an active Data Acquisition alert
C
AlertId
Uniquely identfies an alert
C
AsyncProcess
Represents a subprocess as an asynchronous operation
C
AsyncProcessIf
Interface to asynchronous process
C
CommonDaqController
Implements common behaviour of
OcmDaqController
and
DpmDaqController
►
C
DaqContext
Structure carrying context needed to start a Data Acquisition and construct a Data Product Specification needed to execute merge
C
Source
C
DaqController
Controls the execution of single data acquisition that ultimately result in a set of FITS keywords and/or FITS files
C
DaqControllerFactory
Abstract factory for DaqControllers
C
DaqControllerFactoryDefault
Default factory producing "real" implementations
C
DaqControllerFactoryFake
Factory that creates mock versions
C
DaqControllerMock
Mock version of
daq::DaqController
C
DaqOperationAborted
Started operation was aborted
C
DaqOperationTimeout
Started operation timed out
C
DaqReplyMock
C
DaqSourceError
Represents error in single source
C
DaqSourceErrors
Exception thrown to carry reply errors
C
DaqSources
Data acquisition sources
C
DaqStatusMock
C
DaqStopReplyMock
C
DpmClient
Interface to DPM server
►
C
DpmClientImpl
C
Subscriptions
C
DpmClientMock
Combined mock and fake of interface to DPM server
C
DpmClientParams
Connection parameters for DPM
C
DpmDaqControlAsyncMock
C
DpmDaqController
Implements behaviour from the state NotScheduled to Completed
C
DpPart
Provides information of the location and origin of a FITS file or keywords produced by a data acquisition
►
C
DpSpec
Close representation of the JSON structure but with stronger types
C
Filter
C
SourceFitsFile
C
SourceFitsKeywords
C
Target
C
Transform
C
DpSpecError
C
ErrorEvent
C
EventLog
Represents a collection of events
C
EventLogObserverLogger
A simple
daq::ObservableEventLog
observer that logs observed events to provided logger
C
GenericEvent
Represents a generic event if a more specific event is not usable
C
LogLevel
Ly typed log4cplus::LogLevel (which is an alias to int)
C
Manager
Manager
owns
DaqController
and FitsController (active data acquisitions) instances and multiplexes requests to them
C
ManagerImpl
Implements
daq::Manager
C
ManagerParams
Configurations parameters directly related to manager
C
MetaDaqAsyncMock
C
MetaSource
Keeps relevant state to be able to communicate with a primary data source
C
MockAsyncProcess
Combined fake/mock
C
MockRsyncAsyncProcess
C
MockWorkspace
C
ObservableEventLog
Stores data acquisition status and allows subscription to status changes
►
C
ObservableStatus
Stores data acquisition status and allows subscription to status changes
C
DeferSignal
Defer signal changes until later time
C
OcmAsyncOperations
OCM Async operations
►
C
OcmDaqController
Implements
daq::DaqController
for states responsible to be executed by OCM
C
Aborted
C
Aborting
C
Acquiring
C
NotStarted
C
Starting
C
Stopped
C
Stopping
C
Origin
Describes parsed origin string into its components "host" and "path"
►
C
PendingReplies
Simple class that allows you to keep track of how many replies are pending
C
PendingReply
C
PrimSource
Keeps relevant state to be able to communicate with a primary data source
C
RecCmdsAsyncMock
C
RecStatusMock
C
ReplyToken
Token representing a not-yet-received reply
C
Result
Utility class that represents a result and an error
C
Result< void >
C
RsyncAsyncProcess
Represents an rsync process as an asynchronous operation
C
RsyncAsyncProcessIf
More specialized version for
rsync
which also monitors transfer progress
C
RsyncOptions
Options controlling rsync invocation
C
RsyncProgress
Describes file transfer progress,
C
Source
Simple class that holds the source and associated state
C
Status
Non observable status object that keeps stores status of data acquisition
C
StatusSignal
Observes any status
C
TestDpmDaqController
Fixture for
daq::DaqController
life cycle tests
C
TestSource
Test fixture for source tests
C
Trim
Trim
string from whitespace (' ', '
')
C
UserActionEvent
Event directly related to user action, such as a command to do something
C
Workspace
Interface to interact with DPM workspace
C
WorkspaceImpl
Implementation of
daq::Workspace
►
N
daqif
C
AwaitDaqReplyFake
C
DaqReplyFake
C
DaqReplyMock
C
DaqStatusFake
C
DaqStatusMock
C
FullState
Describes the full state and substate
C
StorageStatusFake
C
Subscription
Subscription
►
N
DpmCtl
C
Clients
C
DpmCtl
Robot library providing keywords for the daqif.DpmDaqControl and daqif.DpmControl interface
►
N
elt
►
N
Fits
C
Fits
Robot library providing FITS related keywords
►
N
metadaq
►
N
simulator
C
Daq
Holds simulated status for DAQ
C
Simulator
Simulator
that implements Modmetadaqsimif and sets up simulation behaviour for
Simulator
C
SimulatorCtl
Simulator
controller that implements Modmetadaqsimif and sets up simulation behaviour for
Simulator
►
N
OcmCtl
C
Clients
C
OcmCtl
Robot library providing keywords for the daqif.OcmDaqControl and stdif interface
►
N
rad
C
IoExecutor
Adapts boost::asio::io_context into a compatible boost::thread Executor type
►
N
rec
►
N
simulator
C
Recording
Holds simulated status for recording
C
Simulator
Simulator
that implements RecCmdsSyncService and sets up simulation behaviour for
Simulator
C
SimulatorCtl
Simulator
controller that implements ModDaqsimif and sets up simulation behaviour for
Simulator
►
N
segfault
C
Init
►
N
server
C
ActionMgr
This class is responsible for the life-cycle management of actions and activities
C
ActionsStd
This class contains the implementation of the actions dealing with the standard commands from stdif.xml and the following signals:
C
Config
This class provide access to the command line options and the configuration parameters stored in the configuration file
C
DataContext
This class provide access to the application run-time data including the in-memory DB
C
DbInterface
This class is the interface to the in-memory DB
C
StdCmdsImpl
►
N
SimCtl
C
SimCtl
Robot library providing keywords for the
SimCtl
interface
C
AsyncProcessTest
C
AwaitStateRequestor
C
CommonArgs
C
DaqControllerFake
C
DaqService
C
DaqWorkspaceTest
C
EventObserver
C
ExitWithErrorCode
C
FixtureBase
C
JsonPrint
C
MalMock
C
ManagerMock
C
MockAbort
Simple class that facilitates mocking of the freestanding asynchronous operations in
daq::op
:
C
MockAsyncOperations
C
MockMal
C
NoArgRequestor
C
OcmDaqService
Implements the MAL interface daqif::OcmDaq (async version)
C
ParsedSource
C
Requestor
C
RsyncAsyncProcessTest
C
SetLogLevelRequestor
C
SimpleDaqRequestor
Simple Daq commands that accepts a single argument
id
and returns a shared_ptr type that can be formatted with ostream<< operator when dereferenced
C
SimpleRequestor
Simple requestor for commands without argument
C
StartDaqRequestor
C
StatusObserverMock
Simple observer used for testing
C
TestAcquiring
C
TestAsyncOpAbort
C
TestAsyncOpAwaitPrim
C
TestAsyncOpAwaitState
C
TestAsyncOpBase
Base fixture for async operation tests
C
TestAsyncOpStart
C
TestAsyncOpStop
Note:
TestAsyncOpBase
set
C
TestAwait
C
TestCfitsio
C
TestConfig
C
TestConfigManager
C
TestDaqControllerAwait
C
TestEventLogObserverLogger
C
TestJson
C
TestKeyword
Note that test cases must use
TypeParam
and cannot declare templated aliases
C
TestLiteralKeyword
C
TestManagerImpl
C
TestManagerImplLifecycle
C
TestNotStarted
C
TestObservableStatus
ObservableStatus test fixture
C
TestOcmDaqControllerLifeCycle
Fixture for
daq::DaqController
life cycle tests
C
TestOcmDaqService
Fixture that sets up a
OcmDaqService
instance with following mockups:
C
TestOcmDaqServiceAbandoned
Fixture for testing when
OcmDaqService
is abandoned (e.g
C
TestPendingReplies
Test fixture for PendingReplies tests
C
TestReadKeywords
C
TestState
Developer notes: OcmDaqController use boost::when_all to compose futures
C
TestStopped
C
TestWriteKeywords
C
UpdateKeywordsRequestor
C
WorkspaceTest
Generated by
1.8.20