C# wrapper class to access and modify registers on a CXP device via a BitFlow frame grabber. More...

Public Member Functions

bool IsBoardOpen ()

Alternate to the IsOpen property. More...

bool GetIsCxp ()

Alternate to the IsCxp property. More...

uint GetBoardNumber ()

Alternate to the BoardNumber property. More...

uint GetBoardSwitch ()

Alternate to the BoardSwitch property. More...

uint GetBoardConnector ()

Alternate to the BoardConnector property. More...

void GetBoardSWConnector (ref uint Switch, ref uint Connector)

Return the board switch and connector

Parameters

Switch	The board switch value of the opened board.
Connector	The board connector of the opened board.

More...

void Open (uint boardNumber)

Open the specified frame grabber board. More...

void OpenSWConnector (uint Switch, uint Connector)

Open the specified frame grabber board. More...

void Close ()

Close the current board, if any. Do nothing, otherwise. More...

uint CXPReadReg (uint address)

Read the value of a single CoaXPress register. More...

uint CXPReadReg (uint link, uint address)

Read the value of a single CoaXPress register. More...

void CXPWriteReg (uint address, uint value)

Write the value of a single CoaXPress register. More...

void CXPWriteReg (uint link, uint address, uint value)

Write the value of a single CoaXPress register. More...

byte[] CXPReadData (uint address, uint bytes)

Read the values from a sequence of CoaXPress registers, and return them as an array. More...

byte[] CXPReadData (uint link, uint address, uint bytes)

Read the values from a sequence of CoaXPress registers, and return them as an array. More...

void CXPWriteData (uint address, byte[] data)

Write data to a sequence of CoaXPress registers. More...

void CXPWriteData (uint link, uint address, byte[] data)

Write data to a sequence of CoaXPress registers. More...

Properties
bool	IsOpen `[get]`
	Query whether or not a board has been successfully opened. More...

bool	IsCxp `[get]`
	Query whether or not the opened BitFlow board is a CoaXPress device. The CXP register methods are non-functional, if the Device isn't CoaXPress. More...

uint	BoardNumber `[get]`
	Query the board number of the opened CXP register device. If opened by switch and connector, this throws an exception. More...

uint	BoardSwitch `[get]`
	Query the board switch of the opened CXP register device. If opened by board number, this throws an exception. More...

uint	BoardConnector `[get]`
	Query the board connector of the opened CXP register device. If opened by board number, this throws an exception. More...

Detailed Description

C# wrapper class to access and modify registers on a CXP device via a BitFlow frame grabber.

Member Function Documentation

◆ Close()

void CXPReg.Device.Close ( )

Close the current board, if any. Do nothing, otherwise.

Exceptions

System.ApplicationError Thrown if there is a problem closing the board.

◆ CXPReadData() [1/2]

byte [] CXPReg.Device.CXPReadData	(	uint	address,
		uint	bytes
	)

Read the values from a sequence of CoaXPress registers, and return them as an array.

Parameters

address	The byte address of the first register to be read.
bytes	The number of bytes to be read from the register space.

Returns: A byte array of all the values read.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPReadReg, CXPWriteReg, CXPWriteData

◆ CXPReadData() [2/2]

byte [] CXPReg.Device.CXPReadData	(	uint	link,
		uint	address,
		uint	bytes
	)

Read the values from a sequence of CoaXPress registers, and return them as an array.

Parameters

link	The camera link to read from.
address	The byte address of the first register to be read.
bytes	The number of bytes to be read from the register space.

Returns: A byte array of all the values read.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPReadReg, CXPWriteReg, CXPWriteData

◆ CXPReadReg() [1/2]

uint CXPReg.Device.CXPReadReg ( uint address )

Read the value of a single CoaXPress register.

Returns: The value of the specified register.

Parameters

address The byte address of the register to be read.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPWriteReg, CXPReadData, CXPWriteData

◆ CXPReadReg() [2/2]

uint CXPReg.Device.CXPReadReg	(	uint	link,
		uint	address
	)

Read the value of a single CoaXPress register.

Returns: The value of the specified register.

Parameters

link	The camera link to read data from.
address	The byte address of the register to be read.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPWriteReg, CXPReadData, CXPWriteData

◆ CXPWriteData() [1/2]

void CXPReg.Device.CXPWriteData	(	uint	address,
		byte[]	data
	)

Write data to a sequence of CoaXPress registers.

Parameters

address	The byte address of the first register to be written.
data	A byte array of data to be written to the register space.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPReadReg, CXPWriteReg, CXPReadData

◆ CXPWriteData() [2/2]

void CXPReg.Device.CXPWriteData	(	uint	link,
		uint	address,
		byte[]	data
	)

Write data to a sequence of CoaXPress registers.

Parameters

link	The camera link to write on.
address	The byte address of the first register to be written.
data	A byte array of data to be written to the register space.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPReadReg, CXPWriteReg, CXPReadData

◆ CXPWriteReg() [1/2]

void CXPReg.Device.CXPWriteReg	(	uint	address,
		uint	value
	)

Write the value of a single CoaXPress register.

Parameters

address	The byte address of the register to be read.
value	The value to write to the specified register.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPReadReg, CXPReadData, CXPWriteData

◆ CXPWriteReg() [2/2]

void CXPReg.Device.CXPWriteReg	(	uint	link,
		uint	address,
		uint	value
	)

Write the value of a single CoaXPress register.

Parameters

link	The camera link to write on.
address	The byte address of the register to be read.
value	The value to write to the specified register.

Exceptions

System.InvalidOperationException	Thrown when the board is not open, and this method is called.
System.ApplicationException	Thrown when an internal error occurs. For more information on the exception, check the Message property.

See also: CXPReadReg, CXPReadData, CXPWriteData

◆ GetBoardConnector()

uint CXPReg.Device.GetBoardConnector ( )

Alternate to the BoardConnector property.

Returns: The opened board connector.

See also: BoardSwitch, GetBoardSwitch

BoardConnector GetBoardSWConnector

◆ GetBoardNumber()

uint CXPReg.Device.GetBoardNumber ( )

Alternate to the BoardNumber property.

Returns: The opened board number

BoardNumber

◆ GetBoardSWConnector()

void CXPReg.Device.GetBoardSWConnector	(	ref uint	Switch,
		ref uint	Connector
	)

Return the board switch and connector

Parameters

Switch	The board switch value of the opened board.
Connector	The board connector of the opened board.

BoardSwitch GetBoardSwitch BoardConnector GetBoardConnector

◆ GetBoardSwitch()

uint CXPReg.Device.GetBoardSwitch ( )

Alternate to the BoardSwitch property.

Returns: The opened board switch.

BoardSwitch

See also: BoardConnector, GetBoardConnector

GetBoardSWConnector

◆ GetIsCxp()

bool CXPReg.Device.GetIsCxp ( )

Alternate to the IsCxp property.

Returns: True if the opened BitFlow board is a CoaXPress device, false otherwise.

IsCxp

◆ IsBoardOpen()

bool CXPReg.Device.IsBoardOpen ( )

Alternate to the IsOpen property.

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

IsOpen

◆ Open()

void CXPReg.Device.Open ( uint boardNumber )

Open the specified frame grabber board.

Parameters

boardNumber The index of the board to be opened.

Exceptions

System.InvalidOperationException	Thrown if this CXPReg interface has already been opened.
System.ApplicationException	Thrown if a board is already opened, if the board cannot be opened, or if the specified board is not a CoaXPress device.

◆ OpenSWConnector()

void CXPReg.Device.OpenSWConnector	(	uint	Switch,
		uint	Connector
	)

Open the specified frame grabber board.

Parameters

Switch	The switch setting of the board to be opened.
Connector	The connector of the board to be opened.

Exceptions

System.InvalidOperationException	Thrown if this CXPReg interface has already been opened.
System.ApplicationException	Thrown if a board is already opened, if the board cannot be opened, or if the specified board is not a CoaXPress device.

Property Documentation

◆ BoardConnector

uint CXPReg.Device.BoardConnector

get

Query the board connector of the opened CXP register device. If opened by board number, this throws an exception.

Returns: The opened board connector.

Exceptions

ApplicationException Thrown if this is not open, or if this was not opened using the switch and connector method.

See also: BoardSwitch, GetBoardSwitch

GetBoardConnector GetBoardSWConnector

◆ BoardNumber

uint CXPReg.Device.BoardNumber

get

Query the board number of the opened CXP register device. If opened by switch and connector, this throws an exception.

Returns: The opened board number.

Exceptions

ApplicationException Thrown if this is not open, or if this was opened using the switch and connector method.

GetBoardNumber

◆ BoardSwitch

uint CXPReg.Device.BoardSwitch

get

Query the board switch of the opened CXP register device. If opened by board number, this throws an exception.

Returns: The opened board switch.

Exceptions

ApplicationException Thrown if this is not open, or if this was not opened using the switch and connector method.

GetBoardSwitch

See also: BoardConnector, GetBoardConnector

GetBoardSWConnector

◆ IsCxp

bool CXPReg.Device.IsCxp

get

Query whether or not the opened BitFlow board is a CoaXPress device. The CXP register methods are non-functional, if the Device isn't CoaXPress.

GetIsCxp

◆ IsOpen

bool CXPReg.Device.IsOpen

get

Query whether or not a board has been successfully opened.

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

IsBoardOpen

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

Generic/Libraries/CXPReg/CXPReg.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Close()

◆ CXPReadData() [1/2]

◆ CXPReadData() [2/2]

◆ CXPReadReg() [1/2]

◆ CXPReadReg() [2/2]

◆ CXPWriteData() [1/2]

◆ CXPWriteData() [2/2]

◆ CXPWriteReg() [1/2]

◆ CXPWriteReg() [2/2]

◆ GetBoardConnector()

◆ GetBoardNumber()

◆ GetBoardSWConnector()

◆ GetBoardSwitch()

◆ GetIsCxp()

◆ IsBoardOpen()

◆ Open()

◆ OpenSWConnector()

Property Documentation

◆ BoardConnector

◆ BoardNumber

◆ BoardSwitch

◆ IsCxp

◆ IsOpen