This interface provides functions to configure and capture data from individual pick-up. More...

#include <TmsC.h>

Inheritance diagram for Tms::PuProcess:

Public Member Functions
	PuProcess (BString name="")

BError	getVersion (BString &version)
	Gets the software version.

BError	getCycleInformation (BUInt32 cycleNumber, CycleInformation &cycleInformation)
	Gets information on given cycle number.

BError	getStatus (PuChannel puChannel, PuStatus &puStatus)

BError	getData (PuChannel puChannel, DataInfo dataInfo, Data &data, BUInt32 &orbitNumber)
	This function returns a set of data from the data present in the data cache or directly from the Pick-Up processing engines. The DataInfo object describes the data required. The call will return the required data along with an error object indicating success or an error condition as appropriate. The call will block until data is ready.

BError	addEventServer (BString name)
	Adds an event server.

BError	requestData (PuChannel puChannel, DataInfo dataInfo)
	This adds a request for some data. The DataInfo object defines the data required. This request can be made at any time. If the data is present in cache the data will be available immediately, if not the system will await the data from a subsequent processing cycle. When the data is available a "data" event will be sent to the client. Not that it is not necessary to use requestData. The client can call getData() directly although this call will block until the data is actually ready.

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 interface provides functions to configure and capture data from individual pick-up.

Constructor & Destructor Documentation

◆ PuProcess()

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

Member Function Documentation

◆ addEventServer()

BError Tms::PuProcess::addEventServer ( BString name )

Adds an event server.

◆ getCycleInformation()

BError Tms::PuProcess::getCycleInformation	(	BUInt32	cycleNumber,
		CycleInformation &	cycleInformation
	)

Gets information on given cycle number.

◆ getData()

BError Tms::PuProcess::getData	(	PuChannel	puChannel,
		DataInfo	dataInfo,
		Data &	data,
		BUInt32 &	orbitNumber
	)

This function returns a set of data from the data present in the data cache or directly from the Pick-Up processing engines. The DataInfo object describes the data required. The call will return the required data along with an error object indicating success or an error condition as appropriate. The call will block until data is ready.

◆ getStatus()

BError Tms::PuProcess::getStatus	(	PuChannel	puChannel,
		PuStatus &	puStatus
	)

◆ getVersion()

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

Gets the software version.

◆ requestData()

BError Tms::PuProcess::requestData	(	PuChannel	puChannel,
		DataInfo	dataInfo
	)

This adds a request for some data. The DataInfo object defines the data required. This request can be made at any time. If the data is present in cache the data will be available immediately, if not the system will await the data from a subsequent processing cycle. When the data is available a "data" event will be sent to the client. Not that it is not necessary to use requestData. The client can call getData() directly although this call will block until the data is actually ready.

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

Account

Public Member Functions

Additional Inherited Members