save/load

Functions
boolvec *	area_read (const char *filename, const char *areaname=NULL, int col1=1, int col2=2, const char *delimiters=" \t", int skip_lines=0, int grow_by=250)
boolvec *	area_load (const char *filename, const char *area_name=NULL)
boolvec *	area_write (const char *filename, const char *area_name="*", const char *delimiter="\t")
boolvec *	area_save (const char *filename, const char *area_name="*")
boolvec *	area_load_bln (const char *filename, const char *areaname="*")
boolvec *	area_load_shp (const char *filename, const char *area_name="*")
boolvec *	area_save_bln (const char *filename, const char *area_name="*")
boolvec *	area_save_shp (const char *filename, const char *area_name="*")

Detailed Description

Function Documentation

boolvec* surfit::area_load	(	const char *	filename,
		const char *	area_name = NULL
	)

Tcl syntax:

area_load filename "area_name"

Description:

loads area from surfit datafile. if no areaname specified, then loads the first area in the file.

Parameters

filename	surfit datafile File Name Expression Syntax filename
area_name	area name for load

Example

area_load "C:\\area.dat" my_area

bool area_load_bln	(	const char *	filename,
		const char *	areaname = "*"
	)

Tcl syntax:

area_load_bln filename "area_name"

Description:

loads area from Surfer BLN files and sets its name to "areaname". Loads all areas from file if no areaname specified.

Example

area_load_bln "C:\\area.bln" area_from_bln

Implemented in library:

libsurfit_io

bool area_load_shp	(	const char *	filename,
		const char *	area_name = "*"
	)

Tcl syntax:

area_load_shp filename "area_name"

Description:

loads area named "area_name" from ERSI shape file. Loads all areas if no area_name specified.

Parameters

filename	ERSI shape file name
area_name	area name for load

Example

area_load_shp "C:\\area.shp" my_area

Implemented in library:

libsurfit_io

boolvec* surfit::area_read	(	const char *	filename,
		const char *	areaname = NULL,
		int	col1 = 1,
		int	col2 = 2,
		const char *	delimiters = " \t",
		int	skip_lines = 0,
		int	grow_by = 250
	)

Tcl syntax:

area_read filename "area_name" first_column_position second_column_position "delimiters" skip_lines grow_by

Description:

reads area from formatted text file and sets its name to "areaname"

Parameters

filename	File Name Expression Syntax name of formatted text file
areaname	name for area dataset
col1	column with X coordinates
col2	column with Y coordinates
skip_lines	number of lines to skip header
delimiters	delimiters between columns. May be " ", "\t", "," or other symbols
grow_by	=250

Example

area_read "C:\\area.txt" my_area area_read "C:\\area2.txt" my_area2 2 3 "\t"

boolvec* surfit::area_save	(	const char *	filename,
		const char *	area_name = "*"
	)

Tcl syntax:

area_save "filename" area_name

Description:

saves area to surfit datafile

Example

area_save "C:\\area.dat" my_area

bool area_save_bln	(	const char *	filename,
		const char *	area_name = "*"
	)

Tcl syntax:

area_save_bln "filename" area_name

Description:

saves area to Surfer BLN file

Parameters

filename	name for BLN file
area_name	area name. If area_name = "*" then saves all areas

Example

area_save_bln "C:\\area.bln" my_area

Implemented in library:

libsurfit_io

bool area_save_shp	(	const char *	filename,
		const char *	area_name = "*"
	)

Tcl syntax:

area_save_shp "filename" area_name

Description:

saves area to ERSI shape file

Parameters

filename	ERSI shape file name
area_name	area name

Example

area_save_shp "C:\\area.shp" my_area

Implemented in library:

libsurfit_io

boolvec* surfit::area_write	(	const char *	filename,
		const char *	area_name = "*",
		const char *	delimiter = "\t"
	)

Tcl syntax:

area_write "filename" area_name "delimiter"

Description:

writes area to formatted text file

Parameters

area_name	name of the area object
filename	text file filename
delimiter	delimiter between columns. May be " ", "\t", "," or other symbols

Example

area_write "C:\\area.txt" my_area