Tms::TmsControl Class Reference

This interface provides functions to control, test and get statistics from the TMS as a whole. More...

#include <TmsC.h>

Inheritance diagram for Tms::TmsControl:

BoapClientObject BSocket BSocket List of all members.

Public Member Functions

 TmsControl (BString name="")
BError getVersion (BString &version)
 Gets the software version.
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 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 Pick­Up 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 puServerStarted (UInt32 number)
 A TmsPuServer has started.
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.

Detailed Description

This interface provides functions to control, test and get statistics from the TMS as a whole.


Constructor & Destructor Documentation

Tms::TmsControl::TmsControl ( BString  name = ""  ) 


Member Function Documentation

BError Tms::TmsControl::getVersion ( BString version  ) 

Gets the software version.

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.

BError Tms::TmsControl::configure ( ConfigInfo  configInfo  ) 

Configure the system for use. This includes mapping the individual physical PickUp channels to logical pickup channels.

BError Tms::TmsControl::getConfiguration ( ConfigInfo configInfo  ) 

Get the current configuration.

BError Tms::TmsControl::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 Tms::TmsControl::getStatus ( BList< NameValue > &  statusList  ) 

Returns the current status of the system. This information includes the number of Pick­Up present and their individual status.

BError Tms::TmsControl::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 Tms::TmsControl::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 Tms::TmsControl::puServerStarted ( UInt32  number  ) 

A TmsPuServer has started.

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.

BError Tms::TmsControl::setTimingSignals ( PuChannel  puPhysChannel,
UInt32  timingSignals 
)

This function sets the given timing signals to the values as defined in the timingSignals bit array.

BError Tms::TmsControl::captureTestData ( PuChannel  puPhysChannel,
TestCaptureInfo  captureInfo,
BArray< UInt64 > &  data 
)

This function will capture test data.

BError Tms::TmsControl::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 Tms::TmsControl::setPupeConfig ( PuChannel  puPhysChannel,
PupeConfig  pupeConfig 
)

Sets special PUPE configuration for test purposes.

BError Tms::TmsControl::getPupeConfig ( PuChannel  puPhysChannel,
PupeConfig pupeConfig 
)

Gets special PUPE configuration for test purposes.


The documentation for this class was generated from the following files:
Generated on Thu Jun 28 10:46:32 2007 for LibTmsApi by  doxygen 1.5.1