Programmer Guide/Shell Items/File/Introducing File Items - Revision history

Jw: /* Binary File Example */

2017-10-11T07:45:30Z

Binary File Example

@@ Line 424: / Line 424: @@
      //
      delete $#f $#matrix $#st $#t
 exit
 </pre>

Jw: /* Binary File Example */

2017-10-11T07:44:00Z

Binary File Example

← Older revision		Revision as of 09:44, 11 October 2017
Line 388:		Line 388:
	if '$#f[?]' != 'file' em -1 ; $#mac - Failed to create #f		if '$#f[?]' != 'file' em -1 ; $#mac - Failed to create #f
	//		//
	// save vector data to section 0		// save vector data to section 0 (next free section)
	//		//
	$#f save $(eval fill(10,1,1)) 0		$#f save $(eval fill(10,1,1))
	//		//
	// save matrix data to section 1		// save matrix data to section 1
Line 396:		Line 396:
	#matrix := eval init(10,10,0)		#matrix := eval init(10,10,0)
	showitem $#matrix		showitem $#matrix
	$#f save $#matrix 1		$#f save $#matrix
	if '$rc' > 0 em $rc ; SAVE failed ($EMSG)		if '$rc' > 0 em $rc ; SAVE failed ($EMSG)
	//		//
	// save matrix data to section 2		// save matrix data to section 2
	//		//
	$#f save $(eval init(10,10,1)) 2		$#f save $(eval init(10,10,1))
	//		//
	// list sections in binary file		// list sections in binary file
Line 426:		Line 426:
	exit		exit
	</pre>		</pre>

	===R Script - Read {{STX}} Binary File Example===		===R Script - Read {{STX}} Binary File Example===

Jw: /* Binary Files */

2015-12-01T08:16:09Z

Binary Files

← Older revision		Revision as of 10:16, 1 December 2015
Line 344:		Line 344:
	**The number of lines.		**The number of lines.
	**The number of columns.		**The number of columns.
	*A file can have any number of sections.		*The file item implements functions to [[../SET_FILE#Binary_Files:_LOAD\|load]] and [[../SET_FILE#Binary_Files:_SAVE\|save]] data to sections and to list existing sections.
	*The file item implements functions to load and save data to sections and to list existing sections.
	*Existing sections can be overwritten by data of the same length. If data is not the same length, the section must be deleted first.		*Existing sections can be overwritten by data of the same length. If data is not the same length, the section must be deleted first.
	*Individual sections or all sections can be deleted (see <code>NEW file</code> and <code>SAVE</code>).		*Individual sections or all sections can be deleted (see <code>NEW file</code> and <code>SAVE</code>).

Jw: /* Binary Header */

2015-12-01T08:13:23Z

Binary Header

← Older revision		Revision as of 10:13, 1 December 2015
Line 358:		Line 358:
	====Binary Header====		====Binary Header====

	The binary file section header is 12 bytes long and contains three ~~awesome~~ 32 bit integers.		The binary file section header is 12 bytes long and contains three 32 bit integers.

	header[0] = the binary file type		;header[0]: the binary file type:
			::0x0102 - 16bit integer
	0x0102 - 16bit integer		::0x0204 - 32bit integer
			::0x0304 - 32bit float
	0x0204 - 32bit integer		::0x0408 - 64bit float
			;header[1]:the number of rows
	0x0304 - 32bit float		:This is stored in a signed integer.
			;header[2]: the number of columns
	0x0408 - 64bit float		:This is stored in a signed integer.

	header[1] = the number of rows

	This is stored in a signed integer.

	header[2] = the number of columns

	This is stored in a signed integer.

	====Binary Data====		====Binary Data====

Jw: /* Binary Files */

2015-12-01T08:10:51Z

Binary Files

← Older revision		Revision as of 10:10, 1 December 2015
Line 335:		Line 335:

	==Binary Files==		==Binary Files==

	Binary file items are supported from {{STX}} version 3.7.x (r603). The following features are available:		Binary file items are supported from {{STX}} version 3.7.x (r603). The following features are available:


	*A binary file can have one or more sections.		*A binary file can have one or more sections.

	*Every section can have a numeric item saved in it (e.g. a table, a value etc.).		*Every section can have a numeric item saved in it (e.g. a table, a value etc.).

	*A section has a header with the following attributes:		*A section has a header with the following attributes:
			**The data type (16-bit integer, 32-bit integer, 32-bit float or 64-bit float).
			**The size of the value in bytes (2, 4 or 8).
	*The data type (16-bit integer, 32-bit integer, 32-bit float or 64-bit float).		**The number of lines.
			**The number of columns.
	*The size of the value in bytes (2, 4 or 8).

	*The number of lines.

	*The number of columns.


	*A file can have any number of sections.		*A file can have any number of sections.

	*The file item implements functions to load and save data to sections and to list existing sections.		*The file item implements functions to load and save data to sections and to list existing sections.

	*Existing sections can be overwritten by data of the same length. If data is not the same length, the section must be deleted first.		*Existing sections can be overwritten by data of the same length. If data is not the same length, the section must be deleted first.

	*Individual sections or all sections can be deleted (see <code>NEW file</code> and <code>SAVE</code>).		*Individual sections or all sections can be deleted (see <code>NEW file</code> and <code>SAVE</code>).

	*Sections can be appended to an existing file.		*Sections can be appended to an existing file.

	The {{STx}} binary file contains no metadata describing the section data! Metadata, if needed, must be stored elsewhere (e.g. in the ~~DataSet~~).		The {{STx}} binary file contains no metadata describing the section data! Metadata, if needed, must be stored elsewhere (e.g. in the project file).

	===Binary File Format===		===Binary File Format===
Line 371:		Line 356:
	The {{Stx}} binary file has the following format:		The {{Stx}} binary file has the following format:

	===Binary Header===		====Binary Header====

	The binary file section header is 12 bytes long and contains three awesome 32 bit integers.		The binary file section header is 12 bytes long and contains three awesome 32 bit integers.
Line 393:		Line 378:
	This is stored in a signed integer.		This is stored in a signed integer.

	===Binary Data===		====Binary Data====

	The binary data is stored directly after the binary header. Note that each column is stored as a vector. The column vectors are stored one after the other.		The binary data is stored directly after the binary header. Note that each column is stored as a vector. The column vectors are stored one after the other.

Jw: /* Binary Data */

2015-12-01T08:08:43Z

Binary Data

← Older revision		Revision as of 10:08, 1 December 2015
Line 393:		Line 393:
	This is stored in a signed integer.		This is stored in a signed integer.

	==Binary Data==		===Binary Data===

	The binary data is stored directly after the binary header. Note that each column is stored as a vector. The column vectors are stored one after the other.		The binary data is stored directly after the binary header. Note that each column is stored as a vector. The column vectors are stored one after the other.
Line 512:		Line 512:
	}		}
	</pre>		</pre>

	==GDX Files==		==GDX Files==

Jw: /* Binary Header */

2015-12-01T08:08:30Z

Binary Header

← Older revision		Revision as of 10:08, 1 December 2015
Line 371:		Line 371:
	The {{Stx}} binary file has the following format:		The {{Stx}} binary file has the following format:

	==Binary Header==		===Binary Header===

	The binary file section header is 12 bytes long and contains three awesome 32 bit integers.		The binary file section header is 12 bytes long and contains three awesome 32 bit integers.

Jw: /* GDX Files */

2015-11-27T15:18:04Z

GDX Files

← Older revision		Revision as of 17:18, 27 November 2015
Line 514:		Line 514:
	==GDX Files==		==GDX Files==

	GDX stands for "graphics data exchange" and is an binary file format a graph item can display in a plot.		GDX stands for "graphics data exchange" and is a binary file format that a graph item can display in a plot.

	The GDX format was introduced to {{STX}} in version 3.9.0		The GDX format was introduced to {{STX}} in version 3.9.0

	[[Category:Programmer Guide]][[Category:Shell Items]][[Category:File Item]]		[[Category:Programmer Guide]][[Category:Shell Items]][[Category:File Item]]

Jw: Script tested: 14.9.2015

2015-09-14T11:12:05Z

Script tested: 14.9.2015

← Older revision		Revision as of 13:12, 14 September 2015
Line 217:		Line 217:
	#f := new file * /XML /Write		#f := new file * /XML /Write
	if '$#f[?]' != 'file' then		if '$#f[?]' != 'file' then
	em -1 ; '$#mac::Error - Failed to create the XML file item'		em -1 ; '$#mac::Error - Failed to create the XML file item'
	end		end
	// do the example		// do the example
Line 261:		Line 261:
	$#f save 'xml_file_example_1.xml'		$#f save 'xml_file_example_1.xml'
	if '$rc' > 0 then		if '$rc' > 0 then
	em $rc ; $#mac - Failed to save "xml_file_example_1.xml"		em $rc ; $#mac - Failed to save "xml_file_example_1.xml"
	end		end
	//		//
Line 269:		Line 269:
	exit		exit
	//		//
	// Ask user to select a file, check if it is ~~an {{STX}} dataset~~ file and		// Ask user to select an STx project file, check if it is a valid project file and
	// find the longest file. Uses the XML file item commands:		// find the longest file. Uses the XML file item commands:
	// load \| goto \| extracttable \| position		// load \| goto \| extracttable \| position
Line 275:		Line 275:
	Example_2:		Example_2:
	readvar #argv #fDatasetPath		readvar #argv #fDatasetPath
			#pwd := pwd // save working directory
	if '$#fDatasetPath' == '' then		if '$#fDatasetPath' == '' then
	// ask user to select dataset file from disk		// ask user to select dataset file from disk
	#caption := set 'Select an {{STx}} project from disk'		#caption := set 'Select an STx project from disk'
	#filetype := set 'STx Project File'		#filetype := set 'STx Project File'
	BUtil FileDialog Open ; $#caption ; $@WORK ; ~~xml~~=$#fileType		BUtil FileDialog Open ; $#caption ; $@WORK ; stxpr=$#fileType
	readvar result #fDatasetPath		readvar result #fDatasetPath
			pwd $#pwd // restore working directory
	if '$#fDatasetPath' == '' exit		if '$#fDatasetPath' == '' exit
	end		end
Line 288:		Line 290:
	$#f load '$#fDataSetPath'		$#f load '$#fDataSetPath'
	if '$rc' > 0 then		if '$rc' > 0 then
	em $rc ; $#mac - Failed to load the file "$#fDatasetPath".		em $rc ; $#mac - Failed to load the file "$#fDatasetPath".
	end		end
	$#f goto '/STXDataSet'		$#f goto '/STXDataSet'
	if '$rc' > 0 em $rc ; $#mac - Invalid ~~{{STX}}~~ project file		if '$rc' > 0 em $rc ; $#mac - Invalid STx project file
	if '$#f[!xattr,AFile]' == 'Link' then		if '$#f[!xattr,AFile]' == 'Link' then
	#msg := set 'The project you chose is linked and contains no'		#msg := set 'The project you chose is linked and contains no'
	#msg := set $#msg ' segments. Please choose an unlinked project.'		#msg := set $#msg ' segments. Please choose an unlinked project.'
	butil 'msgbox msg ; $#msg'		butil 'msgbox msg ; $#msg'
	exit 1 set '$(xml_file_example 2)'		exit 1 set '$(xml_file_example 2)'
Line 307:		Line 309:
	$#f extracttable $#tExt pos ASeg tag ID id L length /Recursive		$#f extracttable $#tExt pos ASeg tag ID id L length /Recursive
	if '$rc' > 0 then		if '$rc' > 0 then
	em $rc ; $#mac - EXTRACTTABLE failed ($EMSG)		em $rc ; $#mac - EXTRACTTABLE failed ($EMSG)
	end		end
	showitem $#tExt ; All segments in the project "$#fDataSetPath"		showitem $#tExt ; All segments in the project "$#fDataSetPath"

Jw: Jw moved page Shell Items/File/Introducing File Items to Programmer Guide/Shell Items/File/Introducing File Items

2015-08-26T11:19:39Z

Jw moved page Shell Items/File/Introducing File Items to Programmer Guide/Shell Items/File/Introducing File Items

← Older revision	Revision as of 13:19, 26 August 2015
(No difference)