Interface to access and modify registers on a CoaXPress camera. More...

#include <CXPReg.hpp>

Classes
struct	PrivateData

Public Member Functions
	Device (BFVOID)

	~Device (BFVOID)

BFVOID	open (const BFU32 boardNumber)

BFVOID	openSWConnector (const BFU32 Switch, const BFU32 Connector)

BFVOID	close (BFVOID)

BFBOOL	isOpen (BFVOID) const

BFBOOL	isCxp (BFVOID) const

BFU32	getBoardNumber (BFVOID) const

BFVOID	getBoardSWConnector (BFU32 &Switch, BFU32 &Connector) const

BFU32	readReg (const BFU32 address) const

BFU32	readReg (const BFU32 link, const BFU32 address) const

BFVOID	writeReg (const BFU32 address, const BFU32 value)

BFVOID	writeReg (const BFU32 link, const BFU32 address, const BFU32 value)

BFSIZET	readData (const BFU32 address, const BFU32 bytesToRead, std::vector< BFU8 > &dataOut) const

BFSIZET	readData (const BFU32 address, const BFU32 bytesToRead, BFU8 *const dataOut, const BFSIZET dataOutSize) const

BFSIZET	readData (const BFU32 link, const BFU32 address, const BFU32 bytesToRead, std::vector< BFU8 > &dataOut) const

BFSIZET	readData (const BFU32 link, const BFU32 address, const BFU32 bytesToRead, BFU8 *const dataOut, const BFSIZET dataOutSize) const

BFVOID	writeData (const BFU32 address, std::vector< BFU8 > const &dataIn)

BFVOID	writeData (const BFU32 address, const BFU8 *const dataIn, const BFSIZET dataInSize)

BFVOID	writeData (const BFU32 link, const BFU32 address, std::vector< BFU8 > const &dataIn)

BFVOID	writeData (const BFU32 link, const BFU32 address, const BFU8 *const dataIn, const BFSIZET dataInSize)

Detailed Description

Interface to access and modify registers on a CoaXPress camera.

The CXPReg::Device class provides an independent interface to CoaXPres registers, as exposed by BitFlow frame grabbers. This may be used simultaneously with the BufferAcquisition classes, or completely independently. BufferAcquisition::BufferInterface implements its own CXP register methods.

Constructor & Destructor Documentation

Device::Device ( BFVOID )

Initializes a new CXPReg::Device instance.

29 : m_pd (*new PrivateData)

30 { }

Device::~Device ( BFVOID )

Cleanup the CXPReg::Device and its resources.

References close().

 {
     close();
     delete &m_pd;
 }

Member Function Documentation

BFVOID Device::close ( BFVOID )

Close the currently open board, if any.

References isOpen().

Referenced by open(), openSWConnector(), and ~Device().

 {
     if (isOpen())
         BiBrdClose(m_pd.hBoard);
 
     m_pd.hBoard = nullptr;
 
     m_pd.boardNumber = ~BFU32(0);
     m_pd.boardSwitch = ~BFU32(0);
     m_pd.boardConnector = ~BFU32(0);
 }

BFU32 Device::getBoardNumber ( BFVOID ) const

Return the opened board number. Returns ~BFU32(0), if the board isn't open, or wasn't opened with a board number (see getBoardSWConnector).

Returns: The system wide BitFlow board index with which the board was opened, if the board was opened by index. ~BFU32(0), if no board is opened, or if the board was opeend by switch and connector.

 {
     return m_pd.boardNumber;
 }

BFVOID Device::getBoardSWConnector	(	BFU32 &	Switch,
		BFU32 &	Connector
	)		const

Retrieve the opened board switch and connector. Retrieves ~BFU32(0), if the board isn't open, or wasn't opened with openSWConnector (see getBoardNumber).

Parameters

[out]	Switch	- Output value of the switch setting used to open the board, if the board has been opened by switch and connector.
[out]	Connector	- Output value of the connector index used to open the board, if the board has been opened by switch and connector.

 {
     Switch = m_pd.boardSwitch;
     Connector = m_pd.boardConnector;
 }

BFBOOL Device::isCxp ( BFVOID ) const

Returns whether or not the open board is a CXP board or not. If not, than the CXP register functions will fail.

Returns: True if a CoaXPress board is open, false otherwise.

References isOpen().

 {
     return isOpen() && BFIsCXP(m_pd.hBoard);
 }

BFBOOL Device::isOpen ( BFVOID ) const

Returns if a board is open or not.

Returns: The open status of this CXPReg::Device.

Referenced by close(), and isCxp().

 {
     return !!m_pd.hBoard;
 }

BFVOID Device::open ( const BFU32 boardNumber )

Open a board with the given index.

Parameters

[in] boardNumber - The system wide BitFlow board index of the board to open. This includes non-CXP devices.

Exceptions

BiException thrown if the board cannot be opened.

References BiTypeAny, BrdOpenOptions, BiException::check(), and close().

 {
     close();
 
     Bd hBoard;
     BiException::check(0, BiBrdOpenEx(BiTypeAny, boardNumber, &hBoard, BrdOpenOptions) );
 
     m_pd.hBoard = hBoard;
     m_pd.boardNumber = boardNumber;
 }

BFVOID Device::openSWConnector	(	const BFU32	Switch,
		const BFU32	Connector
	)

Open a board with the given switch setting and connector index.

Parameters

[in]	Switch	- The board switch setting used to determine which physical board to open.
[in]	Connector	- The index of the connector to be opeend.

Exceptions

BiException thrown if a board with the Switch setting cannot be found, if located board doesn't have a connector with the specified index, or if the board cannot be opened.

References BI_CIERROR_CIBRDOPEN, BI_CIERROR_CISYSBOARDFINDSWCONNECTOR, BrdOpenOptions, BiException::check(), and close().

 {
     close();
 
     CiENTRY entry;
     BFRC rc = CiSysBoardFindSWConnector(CISYS_TYPE_ANY, Switch, Connector, &entry);
     if (BF_OK != rc)
         BiException::check(0, BI_CIERROR_CISYSBOARDFINDSWCONNECTOR);
 
     Bd hBoard;
     rc = CiBrdOpen(&entry, &hBoard, BrdOpenOptions);
     if (BF_OK != rc)
         BiException::check(0, BI_CIERROR_CIBRDOPEN);
 
     m_pd.hBoard = hBoard;
     m_pd.boardSwitch = Switch;
     m_pd.boardConnector = Connector;
 }

BFSIZET Device::readData	(	const BFU32	address,
		const BFU32	bytesToRead,
		std::vector< BFU8 > &	dataOut
	)		const

Read the values from a sequence of CoaXPress registers, returning the length of data read.

Parameters

[in]	address	- The register address on the connected CXP camera to read from.
[in]	bytesToRead	- The number of bytes to be read.
[out]	dataOut	- Output buffer of the data read, resized to fit the data, if necessary

Returns: The number of bytes actually read.

Exceptions

BFCiException thrown if the data read operation fails.

Referenced by readData().

 {
     return readData(0xFF, address, bytesToRead, dataOut);
 }

BFSIZET Device::readData	(	const BFU32	address,
		const BFU32	bytesToRead,
		BFU8 *const	dataOut,
		const BFSIZET	dataOutSize
	)		const

Read the values from a sequence of CoaXPress registers, returning the length of data read. Store as much of the output data as can be in the dataOut buffer, dropping any data that won't fit.

Parameters

[in]	address	- The register address on the connected CXP camera to read from.
[in]	bytesToRead	- The number of bytes to be read.
[out]	dataOut	- Output buffer of the data read. Filled as much as possible, given the dataOutSize.
[in]	dataOutSize	- Byte size of the dataOut buffer.

Returns: The number of bytes actually read.

Exceptions

BFCiException thrown if the data read operation fails.

References readData().

 {
     return readData(0xFF, address, bytesToRead, dataOut, dataOutSize);
 }

BFSIZET Device::readData	(	const BFU32	link,
		const BFU32	address,
		const BFU32	bytesToRead,
		std::vector< BFU8 > &	dataOut
	)		const

Read the values from a sequence of CoaXPress registers, returning the length of data read.

Parameters

[in]	link	- The camera link to read from.
[in]	address	- The register address on the connected CXP camera to read from.
[in]	bytesToRead	- The number of bytes to be read.
[out]	dataOut	- Output buffer of the data read, resized to fit the data, if necessary

Returns: The number of bytes actually read.

Exceptions

BFCiException thrown if the data read operation fails.

References readData().

 {
     // Round the vector size up to the nearest 32-bit WORD byte-size.
     const size_t minimumDataSize = (bytesToRead + 3) & ~3u;
     if (dataOut.size() < minimumDataSize)
         dataOut.resize(minimumDataSize);
 
     return readData(link, address, bytesToRead, dataOut.data(), dataOut.size());
 }

BFSIZET Device::readData	(	const BFU32	link,
		const BFU32	address,
		const BFU32	bytesToRead,
		BFU8 *const	dataOut,
		const BFSIZET	dataOutSize
	)		const

Read the values from a sequence of CoaXPress registers, returning the length of data read. Store as much of the output data as can be in the dataOut buffer, dropping any data that won't fit.

Parameters

[in]	link	- The camera link to read from.
[in]	address	- The register address on the connected CXP camera to read from.
[in]	bytesToRead	- The number of bytes to be read.
[out]	dataOut	- Output buffer of the data read. Filled as much as possible, given the dataOutSize.
[in]	dataOutSize	- Byte size of the dataOut buffer.

Returns: The number of bytes actually read.

Exceptions

BFCiException thrown if the data read operation fails.

References BFCiException::check().

 {
     BFU32 bytesRead;
     BFCiException::check(m_pd.hBoard, BFCXPReadData(m_pd.hBoard, link, address, bytesToRead, &bytesRead, dataOut, dataOutSize) );
     return bytesRead;
 }

BFU32 Device::readReg ( const BFU32 address ) const

Read the value of a single CoaXPress register.

Parameters

[in] address - The register address on the connected CXP camera to read from.

Returns: The value stored at the specified address.

Exceptions

BFCiException thrown if the register read operation fails.

 {
     return readReg(0xFF, address);
 }

BFU32 Device::readReg	(	const BFU32	link,
		const BFU32	address
	)		const

Read the value of a single CoaXPress register.

Parameters

[in]	link	- The camera link to read from.
[in]	address	- The register address on the connected CXP camera to read from.

Returns: The value stored at the specified address.

Exceptions

BFCiException thrown if the register read operation fails.

References BFCiException::check().

 {
     BFU32 value;
     BFCiException::check(m_pd.hBoard, BFCXPReadReg(m_pd.hBoard, link, address, &value) );
     return value;
 }

BFVOID Device::writeData	(	const BFU32	address,
		std::vector< BFU8 > const &	dataIn
	)

Write data to a sequence of CoaXPress registers.

Parameters

[in]	address	- The register address on the connected CXP camera to write to.
[in]	dataIn	- The input data buffer, specifying the data to be written.

Exceptions

BFCiException thrown if the data write operation fails.

Referenced by writeData().

 {
     writeData(0xFF, address, dataIn.data(), dataIn.size());
 }

BFVOID Device::writeData	(	const BFU32	address,
		const BFU8 *const	dataIn,
		const BFSIZET	dataInSize
	)

Write data to a sequence of CoaXPress registers.

Parameters

[in]	address	- The register address on the connected CXP camera to write to.
[in]	dataIn	- The input data buffer, specifying the data to be written.
[in]	dataInSize	- The number of bytes from dataIn that are to be written. This should be no bigger than the physical byte size of dataIn.

Exceptions

BFCiException thrown if the data write operation fails.

References writeData().

 {
     writeData(0xFF, address, dataIn, dataInSize);
 }

BFVOID Device::writeData	(	const BFU32	link,
		const BFU32	address,
		std::vector< BFU8 > const &	dataIn
	)

Write data to a sequence of CoaXPress registers.

Parameters

[in]	link	- The camera link to write on.
[in]	address	- The register address on the connected CXP camera to write to.
[in]	dataIn	- The input data buffer, specifying the data to be written.

Exceptions

BFCiException thrown if the data write operation fails.

References writeData().

 {
     writeData(link, address, dataIn.data(), dataIn.size());
 }

BFVOID Device::writeData	(	const BFU32	link,
		const BFU32	address,
		const BFU8 *const	dataIn,
		const BFSIZET	dataInSize
	)

Write data to a sequence of CoaXPress registers.

Parameters

[in]	link	- The camera link to write on.
[in]	address	- The register address on the connected CXP camera to write to.
[in]	dataIn	- The input data buffer, specifying the data to be written.
[in]	dataInSize	- The number of bytes from dataIn that are to be written. This should be no bigger than the physical byte size of dataIn.

Exceptions

BFCiException thrown if the data write operation fails.

References BFCiException::check().

 {
     BFCiException::check(m_pd.hBoard, BFCXPWriteData(m_pd.hBoard, link, address, const_cast<BFU8*>(dataIn), (BFU32)dataInSize) );
 }

BFVOID Device::writeReg	(	const BFU32	address,
		const BFU32	value
	)

Write the value of a single CoaXPress register.

Parameters

[in]	address	- The register address on the connected CXP camera to write to.
[in]	value	- The value to be written.

Exceptions

BFCiException thrown if the register write operation fails.

 {
     writeReg(0xFF, address, value);
 }

BFVOID Device::writeReg	(	const BFU32	link,
		const BFU32	address,
		const BFU32	value
	)

Write the value of a single CoaXPress register.

Parameters

[in]	link	- The camera link to write on.
[in]	address	- The register address on the connected CXP camera to write to.
[in]	value	- The value to be written.

Exceptions

BFCiException thrown if the register write operation fails.

References BFCiException::check().

 {
     BFCiException::check(m_pd.hBoard, BFCXPWriteReg(m_pd.hBoard, link, address, value) );
 }

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

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation