Phidget Frequency Counter
[Specific Phidgets]

Typedefs
typedef struct _CPhidgetFrequencyCounter *	CPhidgetFrequencyCounterHandle
Enumerations
enum	CPhidgetFrequencyCounter_FilterType { PHIDGET_FREQUENCYCOUNTER_FILTERTYPE_ZERO_CROSSING = 1, PHIDGET_FREQUENCYCOUNTER_FILTERTYPE_LOGIC_LEVEL, PHIDGET_FREQUENCYCOUNTER_FILTERTYPE_UNKNOWN }
Functions
int	CPhidgetFrequencyCounter_create (CPhidgetFrequencyCounterHandle *phid)
int	CPhidgetFrequencyCounter_getFrequencyInputCount (CPhidgetFrequencyCounterHandle phid, int *count)
int	CPhidgetFrequencyCounter_getFrequency (CPhidgetFrequencyCounterHandle phid, int index, double *frequency)
int	CPhidgetFrequencyCounter_getTotalTime (CPhidgetFrequencyCounterHandle phid, int index, __int64 *time)
int	CPhidgetFrequencyCounter_getTotalCount (CPhidgetFrequencyCounterHandle phid, int index, __int64 *count)
int	CPhidgetFrequencyCounter_setTimeout (CPhidgetFrequencyCounterHandle phid, int index, int timeout)
int	CPhidgetFrequencyCounter_getTimeout (CPhidgetFrequencyCounterHandle phid, int index, int *timeout)
int	CPhidgetFrequencyCounter_setEnabled (CPhidgetFrequencyCounterHandle phid, int index, int enabledState)
int	CPhidgetFrequencyCounter_getEnabled (CPhidgetFrequencyCounterHandle phid, int index, int *enabledState)
int	CPhidgetFrequencyCounter_setFilter (CPhidgetFrequencyCounterHandle phid, int index, CPhidgetFrequencyCounter_FilterType filter)
int	CPhidgetFrequencyCounter_getFilter (CPhidgetFrequencyCounterHandle phid, int index, CPhidgetFrequencyCounter_FilterType *filter)
int	CPhidgetFrequencyCounter_reset (CPhidgetFrequencyCounterHandle phid, int index)
int	CPhidgetFrequencyCounter_set_OnCount_Handler (CPhidgetFrequencyCounterHandle phid, int(*fptr)(CPhidgetFrequencyCounterHandle phid, void *userPtr, int index, int time, int counts), void *userPtr)

---

Detailed Description

These calls are specific to the Phidget Frequency Counter object. See your device's User Guide for more specific API details, technical information, and revision details. The User Guide, along with other resources, can be found on the product page for your device.

---

Typedef Documentation

typedef struct _CPhidgetFrequencyCounter* CPhidgetFrequencyCounterHandle

A Phidget FrequencyCounter handle

---

Enumeration Type Documentation

enum CPhidgetFrequencyCounter_FilterType

Filter Types supported by the frequency counter.

Enumerator:

PHIDGET_FREQUENCYCOUNTER_FILTERTYPE_ZERO_CROSSING	Zero crossing signal filter.
PHIDGET_FREQUENCYCOUNTER_FILTERTYPE_LOGIC_LEVEL	Logic level signal filter.
PHIDGET_FREQUENCYCOUNTER_FILTERTYPE_UNKNOWN	Filter type unknown.

---

Function Documentation

int CPhidgetFrequencyCounter_create

(

CPhidgetFrequencyCounterHandle *

phid

)

Creates a Phidget FrequencyCounter handle.

Parameters:

phid

A pointer to an unallocated Phidget FrequencyCounter handle.

int CPhidgetFrequencyCounter_getFrequencyInputCount	(	CPhidgetFrequencyCounterHandle	phid,
		int *	count
	)

Gets the number of inputs supported by this phidget frequency counter.

Parameters:

	phid	An attached phidget frequency counter handle.
	count	The input count.

int CPhidgetFrequencyCounter_getFrequency	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		double *	frequency
	)

Gets the measured frequency of an input, in Hz.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	frequency	The frequency.

int CPhidgetFrequencyCounter_getTotalTime	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		__int64 *	time
	)

Gets the total time that has passed since the last reset on this input, in microseconds.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	time	The time.

int CPhidgetFrequencyCounter_getTotalCount	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		__int64 *	count
	)

Gets the total number of ticks that have happened since the last reset on this input.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	count	The tick count.

int CPhidgetFrequencyCounter_setTimeout	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		int	timeout
	)

Gets the timeout value for an input, in microseconds. This controls the lowest measurable frequency.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	timeout	The timeout.

int CPhidgetFrequencyCounter_getTimeout	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		int *	timeout
	)

Sets the timeout value for an input, in microseconds.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	timeout	The timeout.

int CPhidgetFrequencyCounter_setEnabled	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		int	enabledState
	)

Gets the enabled state for an input.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	enabledState	The enabled state.

int CPhidgetFrequencyCounter_getEnabled	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		int *	enabledState
	)

Sets the enabled state for an input.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	enabledState	The enabled state.

int CPhidgetFrequencyCounter_setFilter	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		CPhidgetFrequencyCounter_FilterType	filter
	)

Gets the filter type for an input.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	filter	The filter type.

int CPhidgetFrequencyCounter_getFilter	(	CPhidgetFrequencyCounterHandle	phid,
		int	index,
		CPhidgetFrequencyCounter_FilterType *	filter
	)

Sets the filter type for an input.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.
	filter	The filter type.

int CPhidgetFrequencyCounter_reset	(	CPhidgetFrequencyCounterHandle	phid,
		int	index
	)

Resets total count and total time for an input.

Parameters:

	phid	An attached phidget frequency counter handle.
	index	The input index.

int CPhidgetFrequencyCounter_set_OnCount_Handler	(	CPhidgetFrequencyCounterHandle	phid,
		int(*)(CPhidgetFrequencyCounterHandle phid, void *userPtr, int index, int time, int counts)	fptr,
		void *	userPtr
	)

Sets a count event handler. This is called when ticks have been counted on an input, or when the timeout has passed.

Parameters:

	phid	A phidget frequency counter handle.
	fptr	Callback function pointer.
	userPtr	A pointer for use by the user - this value is passed back into the callback function.