Tms::PuControl Class Reference

This class defines the parameters for a test data capture. More...

#include <TmsC.h>

Inheritance diagram for Tms::PuControl:

BoapClientObject BSocket BSocket List of all members.

Public Member Functions

 PuControl (BString name="")
BError getVersion (BString &version)
 Gets the software version.
BError init ()
 Initialises the system including loading all of the PUPE engines firmware. The call will return an error object indicating success or an error condition as appropriate.
BError setProcessPriority (UInt32 priority)
 Sets the priority of the process servicing this service.
BError configure (ConfigInfo configInfo)
 Configure the system for use. This includes mapping the individual physical PickUp channels to logical pickup channels.
BError setControlInfo (CycleParam params)
 Sets the control information for the cycle type given and subsequent cycles. 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 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 10ms 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 Pick-Up's 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 getMasterPuChannel (PuChannel &puChannel)
 Returns the master PU Channel for timing.
BError setTestMode (PuChannel puChannel, 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 puChannel, UInt32 timingSignals)
 This function sets the given timing signals to the values as defined in the timingSignals bit array.
BError captureDiagnostics (PuChannel puChannel, TestCaptureInfo captureInfo, BArray< UInt64 > &data)
 This function will capture test data.
BError setTestData (PuChannel puChannel, 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 class defines the parameters for a test data capture.

Cycle information Cycle Type information This interface provides functions to control, test and get statistics from an individual pick-up


Constructor & Destructor Documentation

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


Member Function Documentation

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

Gets the software version.

Parameters:
version A string variable filled in with the version number string.

BError Tms::PuControl::init (  ) 

Initialises the system including loading all of the PUPE engines firmware. The call will return an error object indicating success or an error condition as appropriate.

BError Tms::PuControl::setProcessPriority ( UInt32  priority  ) 

Sets the priority of the process servicing this service.

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

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

BError Tms::PuControl::setControlInfo ( CycleParam  params  ) 

Sets the control information for the cycle type given and subsequent cycles. 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 Tms::PuControl::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 10ms before the next CYCLE_START event.

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

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

BError Tms::PuControl::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::PuControl::getMasterPuChannel ( PuChannel puChannel  ) 

Returns the master PU Channel for timing.

BError Tms::PuControl::setTestMode ( PuChannel  puChannel,
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::PuControl::setTimingSignals ( PuChannel  puChannel,
UInt32  timingSignals 
)

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

BError Tms::PuControl::captureDiagnostics ( PuChannel  puChannel,
TestCaptureInfo  captureInfo,
BArray< UInt64 > &  data 
)

This function will capture test data.

BError Tms::PuControl::setTestData ( PuChannel  puChannel,
Int32  on,
BArray< UInt32 data 
)

This function will set a PU channel to sample data from memory rather than the ADC's.

BError Tms::PuControl::setPupeConfig ( PuChannel  puPhysChannel,
PupeConfig  pupeConfig 
)

Sets special PUPE configuration for test purposes.

BError Tms::PuControl::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 Fri Sep 18 16:33:18 2009 for LibTmsApi by  doxygen 1.5.1