Type holding all types for the RsaInterface in a single namespaced structure. More...

#include <RsaTypes.h>

Inheritance diagram for sf::RsaTypes:

[legend]

Classes
struct	BufferInfo

struct	ParamInfo
	Structure to hold parameter information. More...

struct	ParamState
	Structure to hold a single state consisting of a name and value. More...

struct	ResultInfo

Public Types
enum	EParamFlag { pfReadonly = 1 << 0 , pfEffectsParameter = 1 << 1 , pfEffectsResult = 1 << 2 , pfEffectsData = 1 << 3 , pfChannelSingle = 1 << 4 , pfGate = 1 << 5 , pfMethod = 1 << 6 , pfExport = 1 << 7 , pfSystem = 1 << 8 , pfWriteable = 1 << 9 , pfAlias = 1 << 10 , pfArchive = 1 << 11 , pfWriteAtOff = 1 << 12 }
	Parameter flags for defining parameter behaviour. More...

enum	EResultFlag { rfGate = 1 << 0 , rfIndex = 1 << 1 , rfAsync = 1 << 2 , rfAsyncIndex = 1 << 3 , rfHugeData = 1 << 4 , rfStored = 1 << 5 }
	Result flags for defining result behaviour. More...

enum	EAcquisitionType { atUltrasonic , atEddyCurrent }

enum	EDefaultParam : uint64_t { apNone = 0x0000 , apChannels = 0x0002 , apError = 0x0003 , apErrorMessage = 0x0004 , apAmplitudeUnit = 0x0005 , apUserFirst = 0x000F , apChannel_Mask = 0x4000 , apChannel_RepRate = 0x4001 , apChannel_SyncMode = 0x4002 , apChannel_Gates = 0x4003 , apChannel_Inputs = 0x4004 , apChannel_TimeUnits = 0x4005 , apChannel_CopyDelay = 0x4006 , apChannel_CopyRange = 0x4007 , apChannel_SampleRate = 0x4008 , apChannel_CopyEnable = 0x4009 , apChannel_PopManual = 0x400A , apChannel_BiDirMode = 0x400B , apChannel_UserFirst = 0x401F , apGate_Mask = 0x8000 , apGate_Name = 0x8001 , apGate_Delay = 0x8002 , apGate_Range = 0x8003 , apGate_SlaveTo = 0x8004 , apGate_Enable = 0x8005 , apGate_Method = 0x8006 , apGate_Threshold = 0x8007 , apGate_Amplitude = 0x8008 , apGate_TimeOfFlight = 0x8009 , apGate_UserFirst = 0x801F }

enum	EDefaultResult : uint64_t { arNone = 0x0000 , arUserFirst = 0x0001 , arChannel_Mask = 0x4000 , arChannel_PopIndex = 0x4001 , arChannel_CopyData = 0x4002 , arChannel_CopyIndex = 0x4003 , arChannel_UserFirst = 0x401F , arGate_Amplitude = 0x8001 , arGate_TimeOfFlight = 0x8002 , arGate_Copy = 0x8003 , arGate_Mask = 0x8000 , arGate_UserFirst = 0x801F }

enum	EPopManual { pmDisabled = 0 , pmReady , pmTrigger }
	Enumerate for the pop manual function. More...

typedef unsigned long long	IdType
	Type for gathering parameter ID's.

typedef TVector< IdType >	IdList
	Type for gathering parameter ID's.

typedef void(*	NotifyProc) (void *data, IdType id)
	Function type for the function type which is called when a parameter changes as a result of changes in the interface itself.

typedef TVector< ParamState >	ParamStates
	Vector to specify states.

Detailed Description

Type holding all types for the RsaInterface in a single namespaced structure.

Member Typedef Documentation

◆ IdList

typedef TVector<IdType> sf::RsaTypes::IdList

Type for gathering parameter ID's.

◆ IdType

typedef unsigned long long sf::RsaTypes::IdType

Type for gathering parameter ID's.

◆ NotifyProc

typedef void(* sf::RsaTypes::NotifyProc) (void *data, IdType id)

Function type for the function type which is called when a parameter changes as a result of changes in the interface itself.

◆ ParamStates

typedef TVector<ParamState> sf::RsaTypes::ParamStates

Vector to specify states.

Member Enumeration Documentation

◆ EAcquisitionType

enum sf::RsaTypes::EAcquisitionType

Type of acquisition implementation.

Enumerator
atUltrasonic	Ultrasonic type of implementation (Chan. Gates).
atEddyCurrent	Eddy current type of implementation.

◆ EDefaultParam

enum sf::RsaTypes::EDefaultParam : uint64_t

Acquisition US Parameters. List of ids which must always be present at all times for each ultrasonic acquisition implementation.

Enumerator
apNone	Used to indicate no parameter.
apChannels	Amount of available channels.
apError	Holds the error number of the implementation.
apErrorMessage	Error message.
apAmplitudeUnit	Amplitude unit conversion factor to get the real value from a result.
apUserFirst	First user number from here.
apChannel_Mask	Mask to detect channeled parameter.
apChannel_RepRate	Repetition rate of the interface.
apChannel_SyncMode	Sync mode internal = 0 or external = 1.
apChannel_Gates	Amount of gates for this channel.
apChannel_Inputs	Inputs of this implementation.
apChannel_TimeUnits	Units in which results are generated in seconds.
apChannel_CopyDelay	Delay of the ultrasonic gate for the special copy result.
apChannel_CopyRange	Range of the ultrasonic gate for the special copy result.
apChannel_SampleRate	Sample rate of digitizer in Hz.
apChannel_CopyEnable	Enables the generation data for the copy result. 0 = disabled, 1 = enabled.
apChannel_PopManual	Generates a POP index data entry manually. 0 = Disabled, 1 = Ready, 2 = Trigger. Value is reset to Enabled when trigger passed.
apChannel_BiDirMode	Enables Alternate mode for bidirectional scanning in combination with pop manual. Reversing every other scanline.
apChannel_UserFirst	First user channel number from here.
apGate_Mask	Mask to detect gated parameter.
apGate_Name	Name of this gate.
apGate_Delay	Delay of the ultrasonic gate in seconds.
apGate_Range	Range of the ultrasonic gate in seconds.
apGate_SlaveTo	Other gate the gat eis slaved to.
apGate_Enable	Enables the data generation of the gate.
apGate_Method	Method which is applied on the gate.
apGate_Threshold	Enables the data generation of the gate.
apGate_Amplitude	Averaged gate amplitude.
apGate_TimeOfFlight	Averaged gate time-of-flight.
apGate_UserFirst	Free gate parameters numbers from here.

◆ EDefaultResult

enum sf::RsaTypes::EDefaultResult : uint64_t

Acquisition Ultrasonic Results. List of ids which must always be present at all times for each ultrasonic acquisition implementation.

Enumerator
arNone	Used to indicate no result.
arUserFirst	First user number from here.
arChannel_Mask	Mask to detect channeled result.
arChannel_PopIndex	Index result for position orientation pulse. Holds the sync counter value at that stage.
arChannel_CopyData	Non synchronised result holding a copy of the digitisers' data.
arChannel_CopyIndex	Sync counter value at the time from the copy.
arChannel_UserFirst	Free number from here.
arGate_Amplitude	Delay of the ultrasonic gate in seconds.
arGate_TimeOfFlight
arGate_Copy
arGate_Mask	Mask to detect gated result.
arGate_UserFirst	Free gate results numbers from here.

◆ EParamFlag

enum sf::RsaTypes::EParamFlag

Parameter flags for defining parameter behaviour.

Enumerator
pfReadonly	Parameter cannot be changed at all times.
pfEffectsParameter	Parameter effects other parameters.
pfEffectsResult	Parameter effect result geometry.
pfEffectsData	Parameter effect result data generation.
pfChannelSingle	Parameter has effect on all channels.
pfGate	Parameter is gate specific.
pfMethod	Parameter is method specific.
pfExport	Parameter is exported when system flags has been set.
pfSystem	Parameter is a system setting and is not exported.
pfWriteable	Parameter is always writeable in any mode.
pfAlias	Alias of another parameter in a different form.
pfArchive	Parameter can be stored for restoring settings and must not be used to restore.
pfWriteAtOff	Parameter is only writable at run mode off and must not be used to restore.

◆ EPopManual

enum sf::RsaTypes::EPopManual

Enumerate for the pop manual function.

Enumerator
pmDisabled	Disables manual pop triggering and uses external pop generation.
pmReady	POP manual is enabled or ready from last trigger.
pmTrigger	State to trigger a manual pop.

◆ EResultFlag

enum sf::RsaTypes::EResultFlag

Result flags for defining result behaviour.

Enumerator
rfGate
rfIndex
rfAsync
rfAsyncIndex
rfHugeData
rfStored

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

RsaTypes.h

Classes

Public Types