Component: XML JSON Parser (Runtime Tools)

Author	MatrixTSL
Version	1.0
Category	Runtime Tools

XML JSON Parser component

A component designed to simplify the collection of data from XML and JSON sources. Parses the raw data and creates a dynamic representation of the data that is easy to navigate and interrogate. Also allows the objects to be manually created or edited and then re-exported as XML or JSON format.

Detailed description

No detailed description exists yet for this component

Examples

XML Example

A simple example to read in an XML formatted file and extract data from the structure.

File:XML_Example.zip

A simple example to read a HTML string into the XML parser and extract data from the within the table structure. The HTML string could be provided via a TCP client HTTP GET request.

XML HTML Example

JSON Example

A simple example to read in an JSON formatted file and extract data from the structure.

File:JSON_Example.zip

Downloadable macro reference

	SetObjectString
Sets the data string of an existing object.
[[File:]] -	Object
Handle to the object
- STRING	Data
- VOID	Return

	GetRootHandle
Allows for user to step through the objects manually using the inbuilt runtime api calls.
[[File:]] -	Return

	FindObject
Finds the first instance of an object. Returns the first matching path from the root. Returns 0 if the path was not found.
- STRING	ObjPath
e.g. "rss.channel.title"
[[File:]] -	Return

	FindObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the root.
- STRING	ObjPath
e.g. "rss.channel.title"
- STRING	Return

	AddObject
Adds a tag at the selected location. Use the GetRootHandle and runtime API Tree functions . Returns the handle of the new object.
[[File:]] -	ParentObject
The Object Handle to store the new tag inside
- STRING	Tag
Name of the object
- STRING	Data
data for the object (optional)
[[File:]] -	Return

	FindNextObject
Finds the next instance of an object following a GetObject* call. Returns the first matching path from the last search. Returns 0 if the path was not found.
- STRING	SubObjPath
e.g. "item.title"
[[File:]] -	Return

	ParseJSONDataString
Parses JSON formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the JSON
- STRING	Data
JSON Data string, can be a chunk of a file at a time
- UINT	Length
Number of Bytes to process
- VOID	Return

	GetObjectString
Collects the data string from the specified object.
[[File:]] -	Object
Handle to the object
- STRING	Return

	ClearObjects
Deletes all object data ready for fresh input
- VOID	Return

	GetObjectTag
Collects the tag string from the specified object.
[[File:]] -	Object
Handle to the object
- STRING	Return

	DeleteObject
Deletes a selected tag object.
[[File:]] -	Object
Handle to the object
[[File:]] -	Return

	FindNextObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the last search
- STRING	SubObjPath
e.g. "item.title"
- STRING	Return

	SetObjectTag
Sets the tag name of an existing object.
[[File:]] -	Object
Handle to the object
- STRING	Tag
- VOID	Return

	ParseXMLDataString
Parses XML formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the XML.
- STRING	Data
XML Data string, can be a chunk of a file at a time
- UINT	Length
Number of bytes to process
- VOID	Return

	CreateServerSocket
Creates a listening socket on the selected channel and port ready to accept incoming web page requests.
- BYTE	Channel
- UINT	Port
- BYTE	Return

	IncRxPtr
- BYTE	Channel
- VOID	Return

	CheckSocketActivity
Checks for activity on the server socket and serves out the webpages to any requesting parties.
- BYTE	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	WM_RXMEM
- BYTE	ch
- UINT	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	MODPMSHAPE
Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
- BYTE	Shape
Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
- VOID	Return

	ARB4
Loads the binary-data to an existing arbitrary waveform memory location ARB4.
- BYTE	Waveform
- VOID	Return

	CLKSRRet
Returns the clock source <INT> or <EXT>.
[[File:]] -	Return

	MODPMDEV
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°).
[[File:]] -	Degrees
Sets PM waveform deviation in degrees (-360 - 360).
- VOID	Return

	MSTLOCK
Sends signal to SLAVE generator to get synchronised
- VOID	Return

	HILVL
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V).
[[File:]] -	HighLevel
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V).
- VOID	Return

	ARB3
Loads the binary-data to an existing arbitrary waveform memory location ARB3.
- UINT	Waveform
- VOID	Return

	WAVE
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB
- BYTE	WaveType
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB.
- VOID	Return

	CALADJ
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100).
[[File:]] -	Calibrate
Adjust the selected calibration value (-100 - 100).
- VOID	Return

	STBRet
Returns the value of the Status Byte Register in <nr1> numeric format.
- BYTE	Return

	ARB2
Loads the binary-data to an existing arbitrary waveform memory location ARB2.
- UINT	Waveform
- VOID	Return

	EERRet
Query and clear execution error number register.
- STRING	Return

	MODFMSRC
Sets FM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets FM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODAMFREQ
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ESE
Sets the Standard Event Status Enable Register to the value of <nrf>.
- BYTE	Value
Value of register 0-255
- VOID	Return

	ARB1
Loads the binary-data to an existing arbitrary waveform memory location ARB1.
- UINT	Waveform
16 Bit binary number for arbitrary waveform.
- VOID	Return

	ARB4DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4.
- STRING	Return

	CLS
Clears status byte register of the interface.
- VOID	Return

	MSTRELOCK
Resynchronises the two generators in MASTER-SLAVE mode.
- VOID	Return

	NOISLVL
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%)
- BYTE	Percent
Sets the output noise level in percent. (0 - 50)
- VOID	Return

	LOCKMODE
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP.
- BYTE	Mode
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP).
- VOID	Return

	ADDRESSRet
Returns the instruments address
[[File:]] -	Return

	MODPMSRC
Sets PM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets PM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODPWMSRC
Sets PWM waveform source to; 0 = INT, 1 = EXT.
[[File:]] -	Source
Sets PWM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MOD
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM.
- BYTE	Modulation
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM).
- VOID	Return

	ISTRet
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true.
[[File:]] -	Return

	LRNRet
Returns the complete setup of the instrument as a binary data block
[[File:]] -	Return

	OPCRet
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential.
[[File:]] -	Return

	SWPTYPE
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP.
- BYTE	Type
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP).
- VOID	Return

	PULSRANGE
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3.
- BYTE	Range
Sets the pulse rise and fall range. (1, 2 or 3)
- VOID	Return

	TSTRet
The generator has no self test capability and the response is always 0 <rmt>.
[[File:]] -	Return

	BSTTRGPOL
Sets the burst trigger slope to; 0 = POS, 1 = NEG.
[[File:]] -	Slope
Set the burst trigger slope (0 = POS, 1 = NEG).
- VOID	Return

	ARB3Ret
Returns the binary-data from an existing abbitrary wavefrom memory location.
- UINT	Return

	BSTPHASE
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360)
[[File:]] -	Degrees
Sets the burst phase in degrees (-360 - 360)
- VOID	Return

	IDNRet
Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned.
- STRING	ReturnIDN
- STRING	Return

	SWPTRGPER
Sets the sweep trigger period to <nrf> seconds
[[File:]] -	Seconds
Set the sweep trigger period in seconds.
- VOID	Return

	PULSDLY
Sets the waveform delay to <nrf> sec
[[File:]] -	Sec
- VOID	Return

	Initialise
Opens the COM port ready for communications.
- VOID	Return

Property reference

	Properties
	Connections
	Simulations