File List

Here is a list of all files with brief descriptions:

[detail level 123456789]

▼ _examples
► exampleComponent
► app
► src
businessLogic.cpp	Implementation of the BusinessLogic class
businessLogic.hpp	Business Logic of the example component
main.cpp	Implementation of method RtcComponentMain
wscript
► scripts
wscript
wscript
► exampleCustom
► app
► src
businessLogic.cpp	Implementation of the BusinessLogic class
businessLogic.hpp	Business Logic of the example component
customCmdsImpl.hpp	Implementation of custom MAL commands
customLifeCycle.hpp	Mixin layer that defines a custom life cycle extension
main.cpp	Implementation of method RtcComponentMain
wscript
► client
► src
main.cpp	Implementation of custom client application
wscript
► interface
wscript
► scripts
wscript
wscript
► exampleDataTask
► common
► genFitsData
► src
rtctkExampleDataTaskGenFitsData.py
wscript
► robotTestSupport
► src
► rtctkExampleDataTaskRobotTest
__init__.py
rtctkExampleDataTaskRobotTest.py	Robot test tools for exampleDataTask
wscript
► shmPub
► src
main.cpp	Implementation of custom data source to test Data Tasks
wscript
wscript
► gpu
► app
► src
businessLogic.hpp	Business Logic of the Data Task
computation.hpp	Computation of the Data Task
main.cpp	Implementation of method RtcComponentMain
wscript
► gpuLib
► src
► include
► rtctk
► exampleDataTask
gpuLib.hpp	GPU library for computation
wscript
► scripts
wscript
wscript
► measureTel
► app
► src
businessLogic.hpp	Business Logic of the Data Task
computation.hpp	Computation of the Data Task
main.cpp	Implementation of method RtcComponentMain
wscript
► scripts
wscript
wscript
► optimiser
► app
► src
businessLogic.hpp	Business Logic of the data task Optimiser
computation.hpp	Computation class of the example data task
main.cpp	Implementation of method RtcComponentMain
wscript
► pyLib
► src
► rtctkExampleDataTaskPyLib
__init__.py
rtctkExampleDataTaskPyLib.py	Python implementation of algorithm in a simple data task
wscript
► scripts
wscript
wscript
► telemetry
► app
► src
businessLogic.hpp	Business Logic of the example data task
computation.hpp	Computation class of the example data task
main.cpp	Implementation of method RtcComponentMain
wscript
► scripts
wscript
wscript
wscript
► exampleEndToEnd
► ciiBased
► config
wscript
► scripts
wscript
wscript
► ciiBasedConfigNG
► config
wscript
► scripts
wscript
wscript
► fileBased
► config
wscript
► scripts
► src
rtctkExampleEndToEndPopulateFiles.sh
wscript
wscript
wscript
► exampleMdc
► app
► src
main.cpp	Implementation of a custom Metadata Collector
wscript
► scripts
wscript
wscript
► exampleTelRec
► app
► src
main.cpp	Implementation of a custom Telemetry Recorder
wscript
► scripts
wscript
wscript
► exampleTelRepub
► config
wscript
► scripts
wscript
wscript
► exampleTelSub
► app
► src
main.cpp	Entry point for rtctkExampleTelSub showing how to instantiate a Telemetry Subscriber
wscript
► scripts
wscript
► shmSub
► src
main.cpp	Entry point for rtctkExampleShmSub test utility
wscript
wscript
► exampleTopics
► src
► include
► rtctk
► exampleTopics
topics.hpp	Common topic definitions used in various examples
wscript
wscript
▼ componentFramework
► interfaces
► dataPath
► agnostictopicif
wscript
► mudpiif
► src
► include
mudpi.h	MUDPI structure definition
wscript
wscript
► rtctkif
wscript
wscript
► rtcComponent
► lib
► src
► include
► rtctk
► componentFramework
► detail
rtcComponent.hpp	Provides details for core functionality of an RTC Component
commandReplier.hpp	Receive commands via MAL
commandRequestor.hpp	Send commands using MAL
loopaware.hpp	Lifecycle Extension that makes an RTC Component 'Loopaware'
loopCmdsImpl.hpp	Implementation of MAL commands for layer 'Loopaware'
malEventInjector.hpp	Provides core functionality of an RTC Component
measCmdsImpl.hpp	Implementation of MAL commands for layer 'Measurable'
measurable.hpp	Lifecycle Extension that makes an RTC Component 'Measurable'
model.hpp	In-memory representation of the state machine model
modelBuilderBase.hpp	Base class of the ModelBuilder
modelExport.hpp	Export the state machine model in various formats
modelManipulator.hpp	Manipulate the in-memory state machine model
optCmdsImpl.hpp	Implementation of MAL commands for layer 'Optimisable'
optimisable.hpp	Lifecycle Extension that makes an RTC Component 'Optimisable'
payload.hpp	Defines an agnostic payload type based on std::string
rtcCmdsImpl.hpp	Implementation of MAL commands for layer 'RtcComponent'
rtcComponent.hpp	Lifecycle of a basic 'RtcComponent'
rtcComponentMain.hpp	Provides core functionality of an RTC Component
runnable.hpp	Lifecycle Extension that makes an RTC Component 'Runnable'
stateMachineEngine.hpp	Wrapper around the SCXML State Machine Engine
statePublisher.hpp	Publishes the stdif state topic via MAL
stateSubscriber.hpp	Subscribes to stdif state topic via MAL
stdBizLogicIf.hpp	Business Logic Interfaces with methods to be implemented in layer 'StdComponent'
stdCmdsImpl.hpp	Implementation of MAL commands for layer 'StdComponent'
stdComponent.hpp	Lifecycle of the 'Standard Component'
stopToken.hpp	A simple Stop Token
suspCmdsImpl.hpp	Implementation of MAL commands for layer 'Suspendable'
suspendable.hpp	Lifecycle Extension that makes a 'Loopaware' RTC Component 'Suspendable'
utils.hpp	Various utilities for Life Cycle Extension
commandReplier.cpp	Implementation of the CommandReplier class
commandRequestor.cpp	Implementation of the CommandRequestor class
modelExport.cpp	Implementation of the state machine model export
modelManipulator.cpp	Implementation of the state machine ModelManiplulator class
stateMachineEngine.cpp	Implementation of the wrapper around the rad StateMachineEngine
statePublisher.cpp	Implementation of the StatePublisher class
stateSubscriber.cpp	Implementation of the StateSubscriber class
threadActivity.cpp	Implementation of the ThreadActivity class
threadActivity.hpp	A thread-based activity class
wscript
► testTools
► testComponent
► app
► src
main.cpp	Test component (minimal implementation)
wscript
wscript
wscript
► utSupport
wscript
wscript
► services
► alert
► src
► include
► rtctk
► componentFramework
alertService.hpp	Declares AlertService
alertServiceIf.hpp	Header file for AlertServiceIf and related classes
alertService.cpp	Defines AlertService
alertServiceIf.cpp	Defines AlertService
wscript
► common
► src
► include
► rtctk
► componentFramework
dataPointPath.hpp	Header file for DataPointPath
exceptions.hpp	Provides macros and utilities for exception handling
fileRepository.hpp	Declaration of FileRepository that provides a simple file based repository
fileServiceRegistryAdapter.hpp	Class that implements a very basic service discover mechanism
fitsIoFunctions.hpp	Declaration of FITS I/O helper functions
jsonPayload.hpp	Defines the JSON payload type JsonPayload
matrixBuffer.hpp	Declaration of the MatrixBuffer template class used in APIs
matrixSpan.hpp	Declaration of the MatrixSpan template class used in APIs
repositoryIf.hpp	Header file for RepositoryIf and related base classes
repositoryIfUtils.hpp	Provides utilities to simplify use of RepositoryIf
repositorySubscriberIf.hpp	Header file for RepositorySubscriberIf and related base classes
serviceContainer.hpp	A container that can hold any type of service
serviceDiscovery.hpp	Class that implements a very basic service discover mechanism
serviceRegistryIf.hpp	Class that implements a very basic service discover mechanism
typeTraits.hpp	Provides useful mechanisms to test various type traits
dataPointPath.cpp	Implementation of DataPointPath
exceptions.cpp	Implementation of RTC Toolkit specific exception classes
fileRepository.cpp	Implementation of FileRepository that provides a simple file based repository
fileServiceRegistryAdapter.cpp	Implementation of the ServiceDiscovery class
fitsIoFunctions.cpp	Implementation of FITS I/O helper functions
repositoryIf.cpp	Implementation of RepositoryIf
repositoryIfUtils.cpp	Implementation of RepositoryIf utilities
repositorySubscriberIf.cpp	Implementation of RepositorySubscriberIf
serviceContainer.cpp	Implementation of the ServiceContainer class
serviceDiscovery.cpp	Implementation of the ServiceDiscovery class
serviceRegistryIf.cpp	Implementation of the ServiceDiscovery class
wscript	Common services and utilities shared by other services
► dataPath
► dds
► src
► include
► rtctk
► componentFramework
dds.hpp	Declares common DDS class
ddsCommon.hpp	Declares some common DDS functionality
ddsPub.hpp	DDS Publisher
ddsReaderListener.hpp	DDS Reader Listener
ddsSub.hpp	DDS Subscriber
ddsWriterListener.hpp	DDS Writer Listener
dds.cpp	Declares common DDS class
ddsCommon.cpp	Declares common DDS types
ddsPub.cpp	DDS Publisher
ddsReaderListener.cpp	DDS Reader Listener
ddsSub.cpp	DDS Subscriber
ddsWriterListener.cpp	DDS Writer Listener
wscript
wscript
► dataRecording
► src
► include
► rtctk
► componentFramework
dataPointRecordingUnit.hpp	Recording Unit that can record RTR datapoints
dataRecorder.hpp	FitsRecorder allows to write ColumnData to into fits files in a specified directory
eventRecordingUnit.hpp	Recording Unit that can record events
fitsColumnFormat.hpp	FitscolumnFormat is used to get a fits type from a C++ type. Supports arrays and vectors
fitsDataRecorder.hpp	FitsRecorder allows to write ColumnData to into fits files in a specified directory
ipcqRecordingUnit.hpp	Recording Unit that can record from shared memory queue
recordingInfo.hpp	FitsRecorder allows to write ColumnData to into fits files in a specified directory
recordingTypeTraits.hpp	FitsRecorder allows to write ColumnData to into fits files in a specified directory
recordingUnit.hpp	Abstract base class defining functionality common to all recording units
recordingUtils.hpp	Utility functions for use in data recording
recordingUnit.cpp	Abstract base class defining functionality common to all recording units
wscript
► events
► src
► include
► rtctk
► componentFramework
eventDefinitions.hpp	Framework-provided event definitions
eventServiceIf.hpp	Low-level interface of the event service
malDdsEventService.hpp	Implementation of the event service
typedEventService.hpp	High-level API of the event service
malDdsEventService.cpp	Implementation of the event service
wscript
► logging
► src
► include
► rtctk
► componentFramework
logger.hpp	Logging Support Library based on log4cplus
logger.cpp	Implementation of the logging methods
wscript
► metrics
► src
► include
► rtctk
► componentFramework
componentMetrics.hpp	Declares ComponentMetrics
componentMetricsIf.hpp	Header file for ComponentMetricsIf
componentMetrics.cpp	Defines ComponentMetrics
componentMetricsIf.cpp	Defines ComponentMetrics
wscript
► oldb
► src
► include
► rtctk
► componentFramework
fileOldbAdapter.hpp	Header file needed to instantiate FileOldbAdapter in test components
oldbAdapter.hpp	Header file needed to instantiate a OldbAdapter
oldbIf.hpp	Header file for OldbIf, which defines the API for OldbAdapters
fileOldbAdapter.cpp	A file based OldbAdapter for testing
oldbAdapter.cpp	Implementation of OldbAdapter
oldbIf.cpp	Implementation file of OldbIf, which provides the API for OldbAdapter
wscript	OLDB Service Interface
► persistentRepo
► src
► include
► rtctk
► componentFramework
filePersistentRepoAdapter.hpp	Header file declaring FilePersistentRepoAdapter
pathMapper.hpp	Header file declaring PathMapper
persistentRepoAdapter.hpp	Header file declaring PersistentRepoAdapter
persistentRepoIf.hpp	Header file for PersistentRepoIf, which defines the API for PersistentRepoAdapter
filePersistentRepoAdapter.cpp	Implements FilePersistentRepoAdapter
pathMapper.cpp	Implementation of PathMapper
persistentRepoAdapter.cpp	Implements PersistentRepoAdapter
persistentRepoIf.cpp	Implementation of PersistentRepoIf, which provides the API for PersistentRepoAdapter
wscript	Persistent Configuration Repository Service
► python
► src
► include
► rtctk
► componentFramework
matrixBufferPy.hpp	Declaration of the MatrixBuffer template class used in APIs
vectorPy.hpp	Declaration of the MatrixBuffer template class used in APIs
matrixBufferPy.cpp	Implementation of the MatrixBuffer template class used in APIs
vectorPy.cpp	Implementation of the MatrixBuffer template class used in APIs
wscript
► runtimeRepo
► src
► include
► rtctk
► componentFramework
fileRuntimeRepoAdapter.hpp	Header file needed to instantiate FileRuntimeRepoAdapter in test components
runtimeRepoAdapter.hpp	Header file needed to instantiate a RuntimeRepoAdapter
runtimeRepoIf.hpp	Header file for RuntimeRepoIf, which defines the API for RuntimeRepoAdapters
fileRuntimeRepoAdapter.cpp	A file based RuntimeRepoAdapter for testing
runtimeRepoAdapter.cpp	Implementation of RuntimeRepoAdapter
runtimeRepoIf.cpp	Implementation of RuntimeRepoIf, which provides the API for RuntimeRepoAdapter
wscript	Runtime Configuration Repository Service
► testSupport
► src
fakeRepositoryIf.cpp	Implementation of an in-memory fake RepositoryIf
inMemoryOldb.cpp	Implementation of support functions to provide an in-memory OLDB for testing
wscript
► testTools
► testEventSink
► src
main.cpp	Test program for the Event Service
wscript	Test program for integration testing of EventService
► testEventSource
► src
main.cpp	Test program for the Event Service
wscript	Test program for integration testing of EventService
► testFileRepositoryMultiThread
► src
main.cpp	Test program
wscript	Test program for integration testing of FileRepository under a multi-threaded load
► testOldbAdapter
► src
main.cpp	Test program for OldbAdapter integration tests
wscript	Test program for integration testing of OldbAdapter
► testPersistentRepoAdapter
► src
main.cpp	Test program for PersistentRepoAdapter integration tests
wscript	Test program for integration testing of OldbAdapter
wscript	Various testing and utility programs for integration testing
wscript
wscript
▼ doc
doxygen
▼ reusableComponents
► client
► app
► src
main.cpp	Application to send and receive commands to components via MAL
wscript
► lib
► src
► include
► rtctk
► client
clientLib.hpp	Extendable client library to send and receie commands to components
wscript
wscript
► configTool
► src
► rtctk
► configtool
► cli
__init__.py	Provides classes used specifically to implement the CLI of rtctkConfigTool
argtypes.py	Provides classes for CLI argument type conversions
operations.py	Implementation of the operations for the CLI
► comms
__init__.py	Provides classes to communicate with external services for rtctkConfigTool
config.py	Provides a helper class for dealing with the tool configuration
repository.py	Provides classes for interacting with the repositories asynchronously
rtctk_config_tool.py	Entry point for rtctkConfigTool where the CLI arguments are also defined
wscript
► ctrlMonTool
► src
► rtctk
► reusableComponents
► ctrlmontool
► comms
__init__.py
configuration.py
deployment.py	Provides classes for collecting deployment information and controlling SRTC components
logs.py
oldb.py
stdcmdsfacade.py
updatecmdsfacade.py
► gui
__init__.py
main_window.py
qecpu.py
rtc_component.py
rtc_overview.py
taskfeedback.py
taurusdevicebase.py
taurusstate.py
rtctk_ctrl_mon_tool.py
wscript
► dataTask
► src
► include
► rtctk
► dataTask
messageQueue.hpp	A simple message queue implementation
parameter.hpp	A Parameter class used for Data Tasks
readerHelpers.hpp	Helper methods to read data from shared memory queue
readerThread.hpp	Active class that continuously reads data from shared memory queue
request.hpp	A Request class used in Data Tasks
semaphore.hpp	A simple semaphore implementation
wscript
► metadataCollector
► lib
► src
► include
► rtctk
► metadataCollector
acquisitor.hpp	Lifecycle Extension that makes an RTC Component an 'Acquisitor'
businessLogic.hpp	Business Logic of the example component
commandRequestor.hpp	Lifecycle Extension that makes an RTC Component an 'Acquisitor'
acquisitor.cpp	Lifecycle Extension that makes an RTC Component an 'Acquisitor'
businessLogic.cpp	Implementation of the BusinessLogic class
commandRequestor.cpp	Lifecycle Extension that makes an RTC Component an 'Acquisitor'
wscript
► testClient
► src
main.cpp	Application used to steer Acquisitior componets via metadaqif
wscript
wscript
► rtcSupervisor
► deploy
► src
rtctkRtcSuper_deployFromYaml.py
wscript
► lib
► src
► include
► rtctk
► rtcSupervisor
rtcCommandRequest.hpp	Handles a single command request to an rtcObject
rtcCommandRequestList.hpp	Handles a list of command requests to be run sequentially or in parallel
rtcCommandRequestListSeries.hpp	Handles a series of command request lists
rtcMalContext.hpp	Convenience functions for accessing MAL stubs for the Stdif
rtcObject.hpp	Handles communication with and state recording for one object
rtcObjectConfig.hpp	Config of objects and command lists
rtcSupervisorLib.hpp	Standard enums for rtcSupervisor
rtcCommandRequest.cpp	Stored command for a specified rtcObject
rtcCommandRequestList.cpp	List of objects& commands which can be run sequentially or in parallel
rtcCommandRequestListSeries.cpp	Series of commands request lists which can be used to build run lists and idle lists
rtcMalContext.cpp	Convenience functions to ensure that MAL is loaded correctly for URIs
rtcObject.cpp	Handles communication with and state recording for one object
rtcObjectConfig.cpp	Config of objects and command lists
wscript
► populateConfig
► src
► include
► rtctk
► rtcSupervisor
populateConfig.hpp	Header file for PopulateConfig used for populating the Runtime Configuration Repository
populateConfig.cpp	Implementation of PopulateConfig for populating the Runtime Configuration Repository
wscript
► scripts
► src
rtctkRtcSuper_exercise_components.sh
rtctkRtcSuper_exercise_oldb.sh
rtctkRtcSuper_exercise_oldb2.sh
rtctkRtcSuper_stop_components.sh
wscript
► server
► src
main.cpp	Main based on example component
rtcMonitor.cpp	Monitor thread, just calls the rtcSuper monitor on a periodic basis
rtcMonitor.hpp	Holds monitor thread for asynch ping of supervised objects
rtcSupervisor.cpp	Activities for rtcSupervisor
rtcSupervisor.hpp	Business Logic of the RtcSupervisor based on example component
wscript
► testoldb
► src
main.cpp	Basic test of usage of OLDB from rtcSupervisor
wscript
► testrtcobject
► src
main.cpp	Test of basic rtcObject communication
wscript
► testrtcobjectconfig
► src
main.cpp	Test of object config, ensure it can be read from RTR and basic commanding works
wscript
wscript
► telRec
► src
► include
► rtctk
► telemetryRecorder
businessLogic.hpp	Business Logic of the Telemetry Recorder
businessLogic.cpp	Implementation of the BusinessLogic class
wscript
► telRepub
► src
ddsPubThread.hpp	DDS agnostic topic publioshing thread
main.cpp	Implementation of RtcComponentMain
mudpiProcessingError.hpp	MUDPI processor error codes
mudpiProcessor.cpp	Implementation of MUDPI processor
mudpiProcessor.hpp	MUDPI processor: check and aggregate MUDPI payload to a single topic and put to the queue for publishing
repubBuf.hpp	Buffer that keeps available free samples, and samples that are filled
telRepubBusinessLogic.cpp	Implementation of business logic
telRepubBusinessLogic.hpp	Header file needed to instantiate TelRepubBusinessLogic - Busines Logic for Telemetry Republisher
udpReceiver.cpp	Implementation of UDP receiver
udpReceiver.hpp	UDP receiver: receiving MUDPI and send to MUDPI processor
wscript
► telSub
► bench
► src
main.cpp
wscript	Telemetry Subscriber package
► lib
► src
► include
► rtctk
► telSub
agnosticDataSamples.hpp	Declares AgnosticDataSamples
businessLogic.hpp	Implements the business logic for telSub
correlator.hpp	Declares Correlator
correlatorIf.hpp	Declares CorrelatorIf
dataSampleView.hpp	Declares ShmPublisher
ddsReaderListener.hpp	DDS Reader Listener
ddsWaitSet.hpp	Declares the DdsWaitSet implementation
ddsWaitSetIf.hpp	Declares DdsWaitSetIf
main.hpp	Entry-point for Telemetry Subscriber
operationalLogic.hpp	Declares OperationalLogic
operationalLogicIf.hpp	Declares OperationalLogicIf
shmPublisher.hpp	Declares ShmPublisher
shmPublisherIf.hpp	Declares ShmPublisher
config.hpp	Project-wide configuration header
agnosticDataSamples.cpp	Defines AgnosticDataSamples
businessLogic.cpp	Implements the business logic for telSub
correlator.cpp	Implementation of the Correlator class
dataSampleView.cpp	Definition of data sample classes
ddsReaderListener.cpp	Implementation of DDS Reader Listener
ddsWaitSet.cpp	Implementation of the DdsWaitSet
operationalLogic.cpp	Definition of OperationalLogic
shmPublisher.cpp	ShmPublisher definition
wscript
wscript	Telemetry Subscriber package
wscript
▼ standaloneTools
► genDdsPub
► src
main.cpp	Entry-point for the generic DDS publisher
rtctkGenDdsPublisher.cpp	Defines GenSubReaderListener
rtctkGenDdsPublisher.h	Declares Generic DDS Publisher
rtctkRunManyGenPub.sh
wscript
► genDdsSub
► src
genSubReaderListener.cpp	Defines GenSubReaderListener
genSubReaderListener.h	Declares GenSubReaderListener
main.cpp	Entry-point for the generic DDS subscriber
rtctkRunManyGenSub.sh
wscript
► mudpiPublisher
► fits2txt
► src
rtctkMudpiPublisher_fits2txt.py
wscript
► makebtbl
► src
rtctkMudpiPublisher_makebtbl.py
wscript
► mudpiPublisher
► src
main.cpp	MUDPI Publisher
mudpi.h	MUDPI packet
rtms.h	MUDPI Publisher
wscript	RTC Supervisor test programs build script
► mudpiPublisherReceiver
► src
main.cpp	A simple UDP echo server usage: rtctkMudpiPublisherReceiver <port>
mudpi.h	MUDPI packet
wscript	RTC Supervisor test programs build script
wscript	Supervisor build script
► nomadSupport
► config
wscript
► scripts
► src
rtctkMakeNomadJobs.sh
wscript
wscript
► rawRecorder
► capture
► src
main.cpp	Main entry point for capture
wscript	RTMS pcap recorder
► extractor
► src
cameraFactory.cpp	Implementation of camera factory
cameraFactory.hpp	Fits converter Interface
fitsConverterIf.cpp	Implementation of Fits converter Interface
fitsConverterIf.hpp	Fits converter Interface
genericCamera.cpp	Implementation of Generic Camera which outputs FITS binary tables
genericCamera.hpp	Generic Camera which outputs FITS binary tables
lisaCamera.cpp	Implementation of Lisa Camera Fits converter
lisaCamera.hpp	Lisa Camera Fits converter
main.cpp	Main entry point for extractor
packetCombiner.cpp	Class that combines Frames of a sample
packetCombiner.hpp	Class that combines Frames of a sample
packetFormats.hpp	Lowlevel packet formats
wscript	RTMS pcap recorder
wscript
► shmPub
► src
► include
► rtctk
► standaloneTools
shmPub.hpp	Provides a simple tool to publish data into the shm for data tasks
wscript
► shmSub
► src
► include
► rtctk
► standaloneTools
shmSubscriber.hpp	Declares the ShmSubscriber template program for reading the shared memory queue
shmSubscriber.cpp	Implements non-template methods and routines for ShmSubscriber
wscript
wscript