com.phidgets.IRCodeInfo Class Reference

List of all members.

Public Member Functions
int	getBitCount ()
int	getCarrierFrequency ()
int	getDutyCycle ()
int	getEncoding ()
int	getGap ()
int[]	getHeader ()
int	getLength ()
int	getMinRepeat ()
int[]	getOne ()
int[]	getRepeat ()
IRCode	getToggleMask ()
int	getTrail ()
int[]	getZero ()
	IRCodeInfo (int bitCount) throws PhidgetException
	IRCodeInfo (int encoding, int bitCount) throws PhidgetException
	IRCodeInfo (int encoding, int bitCount, int[] header, int[] zero, int[] one, int trail, int gap) throws PhidgetException
	IRCodeInfo (int encoding, int bitCount, int[] header, int[] zero, int[] one, int trail, int gap, int[] repeat) throws PhidgetException
	IRCodeInfo (int encoding, int bitCount, int[] header, int[] zero, int[] one, int trail, int gap, int[] repeat, int minRepeat, IRCode toggleMask, int length, int carrierFrequency, int dutyCycle) throws PhidgetException
String	toString ()
Static Public Attributes
static final int	ENCODING_BIPHASE = 4
static final int	ENCODING_PULSE = 3
static final int	ENCODING_RC5 = 5
static final int	ENCODING_RC6 = 6
static final int	ENCODING_SPACE = 2
static final int	ENCODING_UNKNOWN = 1
static final int	LENGTH_CONSTANT = 2
static final int	LENGTH_UNKNOWN = 1
static final int	LENGTH_VARIABLE = 3
Package Attributes
int	bitCount = 0
int	carrierFrequency = 38000
int	dutyCycle = 33
int	gap = 0
int	length = LENGTH_UNKNOWN
int	minRepeat = 1
int[]	one = new int[] {0,0}
int[]	repeat = null
int	trail = 0
int[]	zero = new int[] {0,0}
Private Attributes
int	encoding = ENCODING_UNKNOWN
int[]	header = null
IRCode	toggleMask = null

---

Detailed Description

This class represents IR Code Properties needed for transmit.

Author:

Phidget Inc.

Definition at line 12 of file IRCodeInfo.java.

---

Constructor & Destructor Documentation

com.phidgets.IRCodeInfo.IRCodeInfo

(

int

bitCount

)

throws PhidgetException [inline]

Creates a new IR Code Info object.

Parameters:

bitCount

the bit count

Definition at line 60 of file IRCodeInfo.java.

com.phidgets.IRCodeInfo.IRCodeInfo	(	int	encoding,
		int	bitCount
	)		throws PhidgetException [inline]

Creates a new IR Code Info object.

Parameters:

encoding	the encoding - one of ENCODING_SPACE, ENCODING_PULSE, ENCODING_BIPHASE, ENCODING_RC5 or ENCODING_RC6
bitCount	the bit count

Definition at line 72 of file IRCodeInfo.java.

com.phidgets.IRCodeInfo.IRCodeInfo	(	int	encoding,
		int	bitCount,
		int[]	header,
		int[]	zero,
		int[]	one,
		int	trail,
		int	gap
	)		throws PhidgetException [inline]

Creates a new IR Code Info object.

Parameters:

encoding	the encoding - one of ENCODING_SPACE, ENCODING_PULSE, ENCODING_BIPHASE, ENCODING_RC5 or ENCODING_RC6
bitCount	the bit count
header	the header (pulse,space)
zero	the zero (pulse, space)
one	the one (pulse, space)
trail	the trailing pulse
gap	the trailing gap

Definition at line 90 of file IRCodeInfo.java.

com.phidgets.IRCodeInfo.IRCodeInfo	(	int	encoding,
		int	bitCount,
		int[]	header,
		int[]	zero,
		int[]	one,
		int	trail,
		int	gap,
		int[]	repeat
	)		throws PhidgetException [inline]

Creates a new IR Code Info object.

Parameters:

encoding	the encoding - one of ENCODING_SPACE, ENCODING_PULSE, ENCODING_BIPHASE, ENCODING_RC5 or ENCODING_RC6
bitCount	the bit count
header	the header (pulse,space)
zero	the zero (pulse, space)
one	the one (pulse, space)
trail	the trailing pulse
gap	the trailing gap
repeat	the special repeat code

Definition at line 127 of file IRCodeInfo.java.

com.phidgets.IRCodeInfo.IRCodeInfo	(	int	encoding,
		int	bitCount,
		int[]	header,
		int[]	zero,
		int[]	one,
		int	trail,
		int	gap,
		int[]	repeat,
		int	minRepeat,
		IRCode	toggleMask,
		int	length,
		int	carrierFrequency,
		int	dutyCycle
	)		throws PhidgetException [inline]

Creates a new IR Code Info object.

Parameters:

encoding	the encoding - one of ENCODING_SPACE, ENCODING_PULSE, ENCODING_BIPHASE, ENCODING_RC5 or ENCODING_RC6
bitCount	the bit count
header	the header (pulse,space)
zero	the zero (pulse, space)
one	the one (pulse, space)
trail	the trailing pulse
gap	the trailing gap
repeat	the special repeat code
minRepeat	the minimum number of times to repeat the code
toggleMask	the bits to toggle when minRepeat is > 1
length	the length style - one of LENGTH_CONSTANT or LENGTH_VARIABLE
carrierFrequency	the carrier frequency in kHz
dutyCycle	the duty cycle in percent

Definition at line 176 of file IRCodeInfo.java.

---

Member Function Documentation

int com.phidgets.IRCodeInfo.getBitCount

(

)

[inline]

Returns the bit count.

Returns:

bit count

Definition at line 249 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getCarrierFrequency

(

)

[inline]

Returns the carrier frequency.

Returns:

carrier frequency

Definition at line 281 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getDutyCycle

(

)

[inline]

Returns the duty cycle.

Returns:

duty cycle

Definition at line 289 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getEncoding

(

)

[inline]

Returns the encoding.

Returns:

encoding

Definition at line 233 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getGap

(

)

[inline]

Returns the gap.

Returns:

gap

Definition at line 257 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.getHeader

(

)

[inline]

Returns the header.

Returns:

header

Definition at line 297 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getLength

(

)

[inline]

Returns the length style.

Returns:

length style

Definition at line 241 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getMinRepeat

(

)

[inline]

Returns the min repeat.

Returns:

min repeat

Definition at line 273 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.getOne

(

)

[inline]

Returns the one.

Returns:

one

Definition at line 313 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.getRepeat

(

)

[inline]

Returns the repeat code.

Returns:

repeat code

Definition at line 321 of file IRCodeInfo.java.

IRCode com.phidgets.IRCodeInfo.getToggleMask

(

)

[inline]

Returns the toggle mask.

Returns:

toggle mask

Definition at line 329 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.getTrail

(

)

[inline]

Returns the trail.

Returns:

trail

Definition at line 265 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.getZero

(

)

[inline]

Returns the zero.

Returns:

zero

Definition at line 305 of file IRCodeInfo.java.

String com.phidgets.IRCodeInfo.toString

(

)

[inline]

Definition at line 335 of file IRCodeInfo.java.

---

Member Data Documentation

int com.phidgets.IRCodeInfo.bitCount = 0 [package]

Definition at line 52 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.carrierFrequency = 38000 [package]

Definition at line 52 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.dutyCycle = 33 [package]

Definition at line 52 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.encoding = ENCODING_UNKNOWN [private]

Definition at line 52 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.ENCODING_BIPHASE = 4 [static]

BiPhase encoding. This is used with getEncoding

Definition at line 29 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.ENCODING_PULSE = 3 [static]

Pulse encoding. This is used with getEncoding

Definition at line 25 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.ENCODING_RC5 = 5 [static]

RC5 encoding. This is used with getEncoding

Definition at line 33 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.ENCODING_RC6 = 6 [static]

RC6 encoding. This is used with getEncoding

Definition at line 37 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.ENCODING_SPACE = 2 [static]

Space encoding. This is used with getEncoding

Definition at line 21 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.ENCODING_UNKNOWN = 1 [static]

Unknown encoding. This is used with getEncoding

Definition at line 17 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.gap = 0 [package]

Definition at line 52 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.header = null [private]

Definition at line 53 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.length = LENGTH_UNKNOWN [package]

Definition at line 52 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.LENGTH_CONSTANT = 2 [static]

Constant length. This is used with getLength

Definition at line 46 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.LENGTH_UNKNOWN = 1 [static]

Unknown length. This is used with getLength

Definition at line 42 of file IRCodeInfo.java.

final int com.phidgets.IRCodeInfo.LENGTH_VARIABLE = 3 [static]

Variable length. This is used with getLength

Definition at line 50 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.minRepeat = 1 [package]

Definition at line 52 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.one = new int[] {0,0} [package]

Definition at line 53 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.repeat = null [package]

Definition at line 53 of file IRCodeInfo.java.

IRCode com.phidgets.IRCodeInfo.toggleMask = null [private]

Definition at line 54 of file IRCodeInfo.java.

int com.phidgets.IRCodeInfo.trail = 0 [package]

Definition at line 52 of file IRCodeInfo.java.

int [] com.phidgets.IRCodeInfo.zero = new int[] {0,0} [package]

Definition at line 53 of file IRCodeInfo.java.

---

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

• IRCodeInfo.java