mvI2cInterfaceControl Class Reference

Contains features to control the I2C interface. More...

Public Member Functions
synchronized void	delete ()
PropertyS	getMvI2cInterfaceASCIIBuffer ()
	A string property.
PropertyS	getMvI2cInterfaceBinaryBuffer ()
	A string property.
PropertyI64	getMvI2cInterfaceBytesToRead ()
	An integer property.
PropertyI64	getMvI2cInterfaceBytesToWrite ()
	An integer property.
PropertyI64	getMvI2cInterfaceDeviceAddress ()
	An integer property.
PropertyI64	getMvI2cInterfaceDeviceSubAddress ()
	An integer property.
PropertyI	getMvI2cInterfaceEnable ()
	A boolean property.
Method	getMvI2cInterfaceRead ()
	A method object.
PropertyI64	getMvI2cInterfaceSpeed ()
	An enumerated integer property.
Method	getMvI2cInterfaceWrite ()
	A method object.
	mvI2cInterfaceControl (Device pDev)
	Constructs a new mvIMPACT.acquire.mvI2cInterfaceControl object.
	mvI2cInterfaceControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.mvI2cInterfaceControl object.

Protected Member Functions
void	finalize ()
	mvI2cInterfaceControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (mvI2cInterfaceControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Contains features to control the I2C interface.

Contains features to control the I2C interface.

Constructor & Destructor Documentation

mvI2cInterfaceControl() [1/3]

mvI2cInterfaceControl ( long cPtr, boolean cMemoryOwn )

protected

mvI2cInterfaceControl() [2/3]

mvI2cInterfaceControl	(	Device	pDev,
		String	settingName )

Constructs a new mvIMPACT.acquire.mvI2cInterfaceControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

mvI2cInterfaceControl() [3/3]

mvI2cInterfaceControl

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.mvI2cInterfaceControl object.

Parameters

pDev

[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

Member Function Documentation

delete()

synchronized void delete

(

)

finalize()

void finalize ( )

protected

getMvI2cInterfaceASCIIBuffer()

PropertyS getMvI2cInterfaceASCIIBuffer

(

)

A string property.

Buffer for exchanging ASCII data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceBinaryBuffer'.

Buffer for exchanging ASCII data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceBinaryBuffer'.

getMvI2cInterfaceBinaryBuffer()

PropertyS getMvI2cInterfaceBinaryBuffer

(

)

A string property.

Buffer for exchanging binary data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceASCIIBuffer'.

Buffer for exchanging binary data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceASCIIBuffer'.

getMvI2cInterfaceBytesToRead()

PropertyI64 getMvI2cInterfaceBytesToRead

(

)

An integer property.

Number of bytes to read from I2C device.

Number of bytes to read from I2C device.

getMvI2cInterfaceBytesToWrite()

PropertyI64 getMvI2cInterfaceBytesToWrite

(

)

An integer property.

Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

getMvI2cInterfaceDeviceAddress()

PropertyI64 getMvI2cInterfaceDeviceAddress

(

)

An integer property.

I2C device address, must be even.

I2C device address, must be even, blocked addresses: 0x20, 0x30 (Test), 0x32, 0x34, 0x36, 0x3E, 0x60, 0x62, 0x64, 0x66, 0x6E, 0x90, 0x92, 0xA0, 0xA2, 0xA4, 0xA6, 0xAE, 0xB0, 0xB2, 0xB4, 0xB6, 0xB8, 0xBA, 0xBC, 0xBE.

getMvI2cInterfaceDeviceSubAddress()

PropertyI64 getMvI2cInterfaceDeviceSubAddress

(

)

An integer property.

I2C device sub address ignored when set to -1, 2 byte address if bit 0x10000 is set, else 1 Byte.

I2C device sub address ignored when set to -1, 2 byte address if bit 0x10000 is set, else 1 Byte.

getMvI2cInterfaceEnable()

PropertyI getMvI2cInterfaceEnable

(

)

A boolean property.

Controls whether the I2C interface is enabled or not.

Controls whether the I2C interface is enabled or not.

getMvI2cInterfaceRead()

Method getMvI2cInterfaceRead

(

)

A method object.

Command to read data from I2C device.

Command to read data from I2C device.

getMvI2cInterfaceSpeed()

PropertyI64 getMvI2cInterfaceSpeed

(

)

An enumerated integer property.

I2C interface clock frequency.

I2C interface clock frequency.

The following string values might be valid for this feature:

• kHz_100 (Display string: '100 kHz'): default speed
• kHz_400 (Display string: '400 kHz'): fast speed

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getMvI2cInterfaceWrite()

Method getMvI2cInterfaceWrite

(

)

A method object.

Command to write data to I2C device

Command to write data to I2C device

swigRelease()

static long swigRelease ( mvI2cInterfaceControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protected