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

#include <TmsC.h>

Inheritance diagram for Tms::PuControl:

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 (BUInt32 priority)
	Sets the priority of the process servicing this service.

BError	configure (BUInt32 ring, 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 (BUInt32 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, BUInt32 testOutput, BUInt32 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, BUInt32 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< BUInt64 > &data)
	This function will capture test data.

BError	setTestData (PuChannel puChannel, BInt32 on, BArray< BUInt32 > 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.

Public Member Functions inherited from BoapClientObject
	BoapClientObject (BString name="")

virtual	~BoapClientObject ()

BError	connectService (BString name)
	Connects to the named service.

BError	disconnectService ()
	Disconnects from the named service.

BString	getServiceName ()
	Get the name of the service.

BError	ping (BUInt32 &apiVersion)
	Pings the connection and finds the remotes version number.

BError	setConnectionPriority (BoapPriority priority)
	Sets the connection priority.

void	setMaxLength (BUInt32 maxLength)
	Sets the maximum packet length.

void	setTimeout (int timeout)
	Sets the timeout in micro seconds. -1 is wait indefinitely.

	BoapClientObject (BString name)

BError	connectService (BString name)

Public Member Functions inherited from BSocket
	BSocket ()

	BSocket (int fd)

	BSocket (NType type)

	BSocket (int domain, int type, int protocol)

	~BSocket ()

BError	init (int domain, int type, int protocol)

BError	init (NType type)

void	setFd (int fd)

int	getFd ()

BError	bind (const BSocketAddress &add)

BError	connect (const BSocketAddress &add)

BError	shutdown (int how)

BError	close ()

BError	listen (int backlog=5)

BError	accept (int &fd)

BError	accept (int &fd, BSocketAddress &address)

BError	send (const void *buf, BSize nbytes, BSize &nbytesSent, int flags=0)

BError	sendTo (const BSocketAddress &address, const void *buf, BSize nbytes, BSize &nbytesSent, int flags=0)

BError	recv (void *buf, BSize maxbytes, BSize &nbytesRecv, int flags=0)

BError	recvFrom (BSocketAddress &address, void *buf, BSize maxbytes, BSize &nbytesRecv, int flags=0)

BError	recvWithTimeout (void *buf, BSize maxbytes, BSize &nbytesRecv, int timeout, int flags=0)

BError	recvFromWithTimeout (BSocketAddress &address, void *buf, BSize maxbytes, BSize &nbytesRecv, int timeout, int flags=0)

BError	setSockOpt (int level, int optname, void *optval, unsigned int optlen)

BError	getSockOpt (int level, int optname, void optval, unsigned int optlen)

BError	setReuseAddress (int on)

BError	setBroadCast (int on)

BError	setPriority (Priority priority)

BError	getMTU (uint32_t &mtu)

BError	getAddress (BSocketAddress &address)

Additional Inherited Members
Public Types inherited from BSocket
enum	NType { STREAM , DGRAM }

enum	Priority { PriorityLow , PriorityNormal , PriorityHigh }

Protected Member Functions inherited from BoapClientObject
BError	pingLocked (BUInt32 &apiVersion)

BError	checkApiVersion ()

BError	performCall (BoapPacket &tx, BoapPacket &rx)
	Performs a RPC call to the named service.

BError	performSend (BoapPacket &tx)
	Performs a send to the named service.

BError	performRecv (BoapPacket &rx)
	Performs a receive.

virtual BError	handleReconnect (BError err)
	Handle a reconnect performing autorisaztion if required.

BError	performSend (BoapPacket &tx)

BError	performRecv (BoapPacket &rx)

BError	performCall (BoapPacket &tx, BoapPacket &rx)

Protected Attributes inherited from BoapClientObject
BString	oname

BUInt32	oapiVersion

BoapPriority	opriority

BoapService	oservice

int	oconnected

BUInt32	omaxLength

BoapPacket	otx

BoapPacket	orx

BMutex	olock

int	otimeout

int	oreconnect
	Handle an automatic reconnect on timeout.

Detailed Description

This class defines the parameters for a test data capture.

This class stores a Physical Pick-Up channel id This class stores the status of an individual Pick-Up This class describes the configuration of the TMS This class defines the data to be acquired and/or fetched This is the definition of a single data value This class stores the raw data This class defines the Pick-Up state table This class defines the parameters for a PS processing cycle Cycle information Cycle Type information This interface provides functions to control, test and get statistics from an individual pick-up

Constructor & Destructor Documentation

◆ PuControl()

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

Member Function Documentation

◆ captureDiagnostics()

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

This function will capture test data.

◆ configure()

BError Tms::PuControl::configure	(	BUInt32	ring,
		ConfigInfo	configInfo
	)

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

◆ getMasterPuChannel()

BError Tms::PuControl::getMasterPuChannel ( PuChannel & puChannel )

Returns the master PU Channel for timing.

◆ getPupeConfig()

BError Tms::PuControl::getPupeConfig	(	PuChannel	puPhysChannel,
		PupeConfig &	pupeConfig
	)

Gets special PUPE configuration for test purposes.

◆ getStatistics()

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.

◆ getStatus()

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.

◆ getVersion()

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

Gets the software version.

Parameters

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

◆ init()

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.

◆ setControlInfo()

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.

◆ setNextCycle()

BError Tms::PuControl::setNextCycle	(	BUInt32	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.

◆ setProcessPriority()

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

Sets the priority of the process servicing this service.

◆ setPupeConfig()

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

Sets special PUPE configuration for test purposes.

◆ setTestData()

BError Tms::PuControl::setTestData	(	PuChannel	puChannel,
		BInt32	on,
		BArray< BUInt32 >	data
	)

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

◆ setTestMode()

BError Tms::PuControl::setTestMode	(	PuChannel	puChannel,
		BUInt32	testOutput,
		BUInt32	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.

◆ setTimingSignals()

BError Tms::PuControl::setTimingSignals	(	PuChannel	puChannel,
		BUInt32	timingSignals
	)

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

◆ test()

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.

The documentation for this class was generated from the following files:

Account

Public Member Functions

Additional Inherited Members