#include <TmsC.h>
Inheritance diagram for Tms::TmsControl:
Public Member Functions | |
TmsControl (BString name="") | |
BError | getVersion (BString &version) |
Gets the software version. | |
BError | setProcessPriority (UInt32 priority) |
Sets the priority of the process servicing this service. | |
BError | init () |
Initialises the system including resetting all of the PUPE engines firmware. The call will return an error object indicating success or an error condition as appropriate. | |
BError | configure (ConfigInfo configInfo) |
Configure the system for use. This includes mapping the individual physical PickUp channels to logical pickup channels. | |
BError | getConfiguration (ConfigInfo &configInfo) |
Get the current configuration. | |
BError | setControlInfo (CycleParam params) |
Sets the control information for the cycle type given. The parameters for the processing cycle are passed, this includes the Phase and State table information. The call will return an error object indicating success or an error. | |
BError | getControlInfo (BString cycleType, UInt32 puChannel, CycleParam ¶ms) |
Gets the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error. | |
BError | delControlInfo (BString cycleType, UInt32 puChannel) |
Deletes the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error. | |
BError | getControlList (BList< CycleParamItem > &itemList) |
Gets the list of Cycle Parameters present in the system. | |
BError | setNextCycle (UInt32 cycleNumber, BString cycleType) |
Sets the cycle number and type for the next processing cycle. The call will return an error object indicating success or an error condition as appropriate. This should be called at least 100ms before the next CYCLE_START event. | |
BError | test (BList< BError > &errors) |
Performs a basic test of the system returning a list of errors. The call will return an error object indicating success or an error condition as appropriate. | |
BError | getStatus (BList< NameValue > &statusList) |
Returns the current status of the system. This information includes the number of PickUp present and their individual status. | |
BError | getStatistics (BList< NameValue > &statsList) |
Returns a list of the statistic values as name/value pairs. The call will return an error object indicating success or an error condition as appropriate. | |
BError | getPuChannel (UInt32 puChannel, PuChannel &puPhysChannel) |
Returns the physical module/Pupe/Channel number given a logical PickUp id. This can be used so that the individual PickUps test functions can be accessed etc. | |
BError | setTestMode (PuChannel puPhysChannel, UInt32 testOutput, UInt32 timingDisableMask) |
The signal source for the digital test output connector. 0: None, 1: FrefLocal. The timingDisableMask bit mask defines which of the timing inputs should be disabled. If a timing input is disabled it can be still operated by software command. | |
BError | setTimingSignals (PuChannel puPhysChannel, UInt32 timingSignals) |
This function sets the given timing signals to the values as defined in the timingSignals bit array. | |
BError | captureTestData (PuChannel puPhysChannel, TestCaptureInfo captureInfo, BArray< UInt64 > &data) |
This function will capture test data. | |
BError | setTestData (PuChannel puPhysChannel, Int32 on, BArray< UInt32 > data) |
This function will set a PU channel to sample data from memory rather than the ADC's. | |
BError | setPupeConfig (PuChannel puPhysChannel, PupeConfig pupeConfig) |
Sets special PUPE configuration for test purposes. | |
BError | getPupeConfig (PuChannel puPhysChannel, PupeConfig &pupeConfig) |
Gets special PUPE configuration for test purposes. | |
BError | puServerStarted (UInt32 number) |
A TmsPuServer has started. |
Tms::TmsControl::TmsControl | ( | BString | name = "" |
) |
Gets the software version.
version | A string variable filled in with the version number string. |
Sets the priority of the process servicing this service.
priority | This is the priority of the process. It can be set to one of: PriorityLow, PriorityNormal, PriorityHigh. |
BError Tms::TmsControl::init | ( | ) |
Initialises the system including resetting all of the PUPE engines firmware. The call will return an error object indicating success or an error condition as appropriate.
This function restarts the TMS system. It re-initialises each of the TmsPuServer processes running on the Module Controllers and reboots each of the PUPE boards from scratch.
BError Tms::TmsControl::configure | ( | ConfigInfo | configInfo | ) |
Configure the system for use. This includes mapping the individual physical PickUp channels to logical pickup channels.
configInfo | The channel mapping table. |
BError Tms::TmsControl::getConfiguration | ( | ConfigInfo & | configInfo | ) |
Get the current configuration.
configInfo | The channel mapping table that is filled in with the current curent channel mapping. |
BError Tms::TmsControl::setControlInfo | ( | CycleParam | params | ) |
Sets the control information for the cycle type given. The parameters for the processing cycle are passed, this includes the Phase and State table information. The call will return an error object indicating success or an error.
params | Cycle information parameters (state/phase table information). |
BError Tms::TmsControl::getControlInfo | ( | BString | cycleType, | |
UInt32 | puChannel, | |||
CycleParam & | params | |||
) |
Gets the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error.
cycleType | This string defines the cycle type for which to get the information. | |
puChannel | This defines the channel to get the information for. 0 means all channels. | |
params | The resuting cycle parameters are placed in this object. |
Deletes the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error.
cycleType | This string defines the cycle type to delete from the database. | |
puChannel | This defines the specific channel to delete the information for. 0 means all channels. |
BError Tms::TmsControl::getControlList | ( | BList< CycleParamItem > & | itemList | ) |
Gets the list of Cycle Parameters present in the system.
itemList | The list of CycleType information is returned. |
Sets the cycle number and type for the next processing cycle. The call will return an error object indicating success or an error condition as appropriate. This should be called at least 100ms before the next CYCLE_START event.
cycleNumber | This is the next cycle number. This should be an incrementing 32bit unsigned value. | |
cycleType | This is a string defining the cycle type for the next cycle. |
Performs a basic test of the system returning a list of errors. The call will return an error object indicating success or an error condition as appropriate.
errors | The list of errors is placed in this list object. |
Returns the current status of the system. This information includes the number of PickUp present and their individual status.
statusList | The list of status items is placed in this list object. |
Returns a list of the statistic values as name/value pairs. The call will return an error object indicating success or an error condition as appropriate.
statsList | The statistics list is placed in this list object. |
Returns the physical module/Pupe/Channel number given a logical PickUp id. This can be used so that the individual PickUps test functions can be accessed etc.
puChannel | The logical channel number. | |
puPhysChannel | The physical channel identifier is returned in this variable. |
BError Tms::TmsControl::setTestMode | ( | PuChannel | puPhysChannel, | |
UInt32 | testOutput, | |||
UInt32 | timingDisableMask | |||
) |
The signal source for the digital test output connector. 0: None, 1: FrefLocal. The timingDisableMask bit mask defines which of the timing inputs should be disabled. If a timing input is disabled it can be still operated by software command.
puPhysChannel | The physical channel identifier. | |
testOutput | The signal to output on the test output. 0 is FREF any other value is undefined at the moment. | |
timingDisableMask | This 8 bit mask defines which of the timing input signals are disabled. |
This function sets the given timing signals to the values as defined in the timingSignals bit array.
puPhysChannel | The physical channel identifier. | |
timingSignals | The 8 bit mask defining the state of the software driven timing signals. |
BError Tms::TmsControl::captureTestData | ( | PuChannel | puPhysChannel, | |
TestCaptureInfo | captureInfo, | |||
BArray< UInt64 > & | data | |||
) |
This function will capture test data.
puPhysChannel | The physical channel identifier. | |
captureInfo | The specification of the diagnostics trigger and data to capture. | |
data | The darw 64bit data array is stored in this array. |
This function will set a PU channel to sample data from memory rather than the ADC's.
puPhysChannel | The physical channel identifier. | |
on | Boolean to enable the internal data source. 0 is off, 1 is on. | |
data | The array of 32bit data values to use as the FREF,Sigma,DeltaX and DeltaY test signal. |
BError Tms::TmsControl::setPupeConfig | ( | PuChannel | puPhysChannel, | |
PupeConfig | pupeConfig | |||
) |
Sets special PUPE configuration for test purposes.
puPhysChannel | The physical channel identifier. | |
pupeConfig | The configuration parameters to use. |
BError Tms::TmsControl::getPupeConfig | ( | PuChannel | puPhysChannel, | |
PupeConfig & | pupeConfig | |||
) |
Gets special PUPE configuration for test purposes.
puPhysChannel | The physical channel identifier. | |
pupeConfig | The returned configuration parameters. |
A TmsPuServer has started.
number | The number of the PuServer started. |