nScopeAPI_sampleTiming.h File Reference

contains function headers for controlling the nScope sample timing More...

Functions
NSCOPE_API ErrorType	nScope_set_sample_rate_in_hz (ScopeHandle nScope, double sample_hz)
	set the sample rate More...
NSCOPE_API ErrorType	nScope_get_sample_rate_in_hz (ScopeHandle nScope, double *sample_hz)
	get the sample rate More...
NSCOPE_API ErrorType	nScope_set_time_between_samples_in_seconds (ScopeHandle nScope, double sample_time_seconds)
	set the time between samples in seconds More...
NSCOPE_API ErrorType	nScope_get_time_between_samples_in_seconds (ScopeHandle nScope, double *sample_time_seconds)
	get the time between samples in seconds More...
NSCOPE_API ErrorType	nScope_set_time_between_samples_in_minutes (ScopeHandle nScope, double sample_time_minutes)
	set the time between samples in minutes More...
NSCOPE_API ErrorType	nScope_get_time_between_samples_in_minutes (ScopeHandle nScope, double *sample_time_minutes)
	get the time between samples in minutes More...
NSCOPE_API ErrorType	nScope_set_time_between_samples_in_ms (ScopeHandle nScope, double sample_time_ms)
	set the time between samples in milliseconds More...
NSCOPE_API ErrorType	nScope_get_time_between_samples_in_ms (ScopeHandle nScope, double *sample_time_ms)
	get the time between samples in milliseconds More...
NSCOPE_API ErrorType	nScope_set_time_between_samples_in_us (ScopeHandle nScope, double sample_time_us)
	set the time between samples in microseconds More...
NSCOPE_API ErrorType	nScope_get_time_between_samples_in_us (ScopeHandle nScope, double *sample_time_us)
	get the time between samples in microseconds More...

Documentation

contains function headers for controlling the nScope sample timing

Function Documentation

NSCOPE_API ErrorType nScope_get_sample_rate_in_hz	(	ScopeHandle	nScope,
		double *	sample_hz
	)

get the sample rate

Gets the scope sample rate in Hz, stores it in sample_hz

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[out]	sample_hz	pointer to double to store actual sample rate in Hz

NSCOPE_API ErrorType nScope_get_time_between_samples_in_minutes	(	ScopeHandle	nScope,
		double *	sample_time_minutes
	)

get the time between samples in minutes

Gets the time between samples in minutes, stores it in sample_time_minutes

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[out]	sample_time_minutes	pointer to double to store actual time between samples

NSCOPE_API ErrorType nScope_get_time_between_samples_in_ms	(	ScopeHandle	nScope,
		double *	sample_time_ms
	)

get the time between samples in milliseconds

Gets the time between samples in milliseconds, stores it in sample_time_ms

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[out]	sample_time_ms	pointer to double to store actual time between samples

NSCOPE_API ErrorType nScope_get_time_between_samples_in_seconds	(	ScopeHandle	nScope,
		double *	sample_time_seconds
	)

get the time between samples in seconds

Gets the time between samples in seconds, stores it in sample_time_seconds

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[out]	sample_time_seconds	pointer to double to store actual time between samples

NSCOPE_API ErrorType nScope_get_time_between_samples_in_us	(	ScopeHandle	nScope,
		double *	sample_time_us
	)

get the time between samples in microseconds

Gets the time between samples in microseconds, stores it in sample_time_us

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[out]	sample_time_us	pointer to double to store actual time between samples

NSCOPE_API ErrorType nScope_set_sample_rate_in_hz	(	ScopeHandle	nScope,
		double	sample_hz
	)

set the sample rate

Sets the scope sample rate in Hz

Not all sample rates can be acheived, nScope will automatically choose the closest approximation

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[in]	sample_hz	desired sample rate in Hz

NSCOPE_API ErrorType nScope_set_time_between_samples_in_minutes	(	ScopeHandle	nScope,
		double	sample_time_minutes
	)

set the time between samples in minutes

Not all sample rates can be acheived, nScope will automatically choose the closest approximation

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[in]	sample_time_minutes	desired time between samples in minutes

NSCOPE_API ErrorType nScope_set_time_between_samples_in_ms	(	ScopeHandle	nScope,
		double	sample_time_ms
	)

set the time between samples in milliseconds

Not all sample rates can be acheived, nScope will automatically choose the closest approximation

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[in]	sample_time_ms	desired time between samples in milliseconds

NSCOPE_API ErrorType nScope_set_time_between_samples_in_seconds	(	ScopeHandle	nScope,
		double	sample_time_seconds
	)

set the time between samples in seconds

Not all sample rates can be acheived, nScope will automatically choose the closest approximation

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[in]	sample_time_seconds	desired time between samples in seconds

NSCOPE_API ErrorType nScope_set_time_between_samples_in_us	(	ScopeHandle	nScope,
		double	sample_time_us
	)

set the time between samples in microseconds

Not all sample rates can be acheived, nScope will automatically choose the closest approximation

Returns

ErrorType

Parameters

[in]	nScope	ScopeHandle object
[in]	sample_time_us	desired time between samples in microseconds