Detailed Description

"Pirouette" TXT loader/saver

This is how a dataset will look like by selecting the whole spreadsheet in Pirouette (Informetrix Inc.) and pasting it into Excel. See Figure 1 for specification.

Figure 1 - "Pirouette" TXT file type

Definition at line 8 of file dataio_txt_pir.m.

Inheritance diagram for dataio_txt_pir:

Collaboration diagram for dataio_txt_pir:

Public Member Functions
function	load (in o)
	Loader. More...

function	save (in o, in data)
	Saver. More...

function	load (in filename, in range)

function	get_description (in o, in flag_short)

function	setbatch (in o, in params)
	Sets several properties of an object at once. More...

function	get_methodname (in o, in flag_short)

function	get_report (in o)
	Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication. More...

function	get_html (in o, in flag_stylesheet)

function	get_params (in o, in data)
	Calls Parameters GUI. More...

function	extract_log (in o)

function	get_ancestry (in o, in flag_title)

Public Attributes
Property	height
	(optional) Image height. If specified, will assign it the loaded dataset More...

Property	direction

Constant Property	defaultrange = [1801.47, 898.81]

Property	filename

Property	title

Property	color

Protected Member Functions
function	do_get_report (in o)
	Default report. More...

function	do_get_html (in o)
	Abstract. HTML inner body. More...

Protected Attributes
Property	flag_xaxis

Property	classtitle
	Class Title. Should have a descriptive name, as short as possible. More...

Property	short
	Short for the method name. More...

Property	flag_params

Property	flag_ui
	(GUI setting) Whether to "publish" in blockmenu and datatool. Note that a class can be "published" without a GUI (set flag_params=0 in this case, at the class constructor). More...

Property	moreactions
	(GUI setting) String cell containing names of methods that may be called from the GUIs More...

Member Function Documentation

function irobj::do_get_html ( in o )

protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in o )

protectedinherited

Default report.

function irobj::extract_log ( in o )

inherited

Parameters

o

Returns: [o, log]

function irobj::get_ancestry	(	in	o,
		in	flag_title
	)

inherited

Parameters

o
flag_title=1

function irobj::get_description	(	in	o,
		in	flag_short
	)

inherited

Returns description string

Precedence according with flag_short:

0: title > short > classtitle
1: short > title > classtitle

Parameters

flag_short=0 I am sealing this to make sure that no class will try to improvise on this function.

function irobj::get_html	(	in	o,
		in	flag_stylesheet
	)

inherited

Parameters

flag_stylesheet=1 Whether to include the stylesheet in the HTML

function irobj::get_methodname	(	in	o,
		in	flag_short
	)

inherited

This is used only to compose sequence string e.g. xxx->yyy->zzz

Parameters

flag_short=0

function irobj::get_params	(	in	o,
		in	data
	)

inherited

Calls Parameters GUI.

If flag_params, tries uip_<class>.m. If fails, tries uip_<ancestor>.m and so on

function irobj::get_report ( in o )

inherited

Object reports are plain text. HTML would be cool but c'mon, we don't need that sophistication.

function dataio_txt_pir::load ( in o )

Loader.

function dataio::load	(	in	filename,
		in	range
	)

inherited

function dataio_txt_pir::save	(	in	o,
		in	data
	)

Saver.

function irobj::setbatch	(	in	o,
		in	params
	)

inherited

Sets several properties of an object at once.

Parameters

o
params	Cell followint the pattern {'property1', value1, 'property2', value2, ...}

Member Data Documentation

Property irobj::classtitle

protectedinherited

Class Title. Should have a descriptive name, as short as possible.

Definition at line 50 of file irobj.m.

Property irobj::color

inherited

=[0, .8, 0]. multipurpose feature, routines may use it for different things. Major use is to change the background of objtool and blockmenu. See also classes_html.m

Definition at line 42 of file irobj.m.

Constant Property dataio::defaultrange = [1801.47, 898.81]

inherited

Definition at line 7 of file dataio.m.

Property dataio_txt_pir::direction

='hor'. Whether the pixels are taken horizontally ('hor') or vertically ('ver') to form the image. It was found that OPUS numbers the point in the image map left-right, bottom-up, hence 'hor'. Same as irdata.direction (although irdata.direction has a different default).

Definition at line 19 of file dataio_txt_pir.m.

Property dataio::filename

inherited

Definition at line 12 of file dataio.m.

Property irobj::flag_params

protectedinherited

=1. (GUI setting) Whether to call a GUI when the block is selected in blockmenu.m . If true, a routine called "uip_"<class name> will be called.

Definition at line 57 of file irobj.m.

Property irobj::flag_ui

protectedinherited

(GUI setting) Whether to "publish" in blockmenu and datatool. Note that a class can be "published" without a GUI (set flag_params=0 in this case, at the class constructor).

Definition at line 60 of file irobj.m.

Property dataio::flag_xaxis

protectedinherited

Definition at line 17 of file dataio.m.

Property dataio_txt_pir::height

(optional) Image height. If specified, will assign it the loaded dataset

Definition at line 14 of file dataio_txt_pir.m.

Property irobj::moreactions

protectedinherited

(GUI setting) String cell containing names of methods that may be called from the GUIs

Definition at line 63 of file irobj.m.

Property irobj::short

protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property irobj::title

inherited

Definition at line 38 of file irobj.m.

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

dataio_txt_pir.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation