Detailed Description

Records properties from a block.

Definition at line 2 of file ttlog_props.m.

Inheritance diagram for ttlog_props:

Collaboration diagram for ttlog_props:

Public Member Functions
function	ttlog_props ()

function	record (in o, in pars)

function	get_X (in o, in aggr)
	Returns recorded information. More...

function	get_insane_html (in o, in pars)

function	extract_dataset (in o)
	Generates one dataset with columns being propnames. More...

function	get_rate (in o)

function	get_flag_perc (in o)
	Returns whether the value returned by get_rate() is a percentage or not. More...

function	get_legend (in o)

function	get_rates (in o)
	Returns all recorded values of property specified by ttlog_props::idx_default. More...

function	get_unit (in o)

function	allocate (in o, in tt)
	Called to pre-allocate matrices after `classlabels` and `rowlabels` are set. More...

function	extract_datasets (in o)
	Abstract. Generates one dataset per row, containing percentages. More...

function	get_format (in o)
	Returns format for sprintf() More...

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	propnames
	Properties to record. More...

Property	propunits
	(Optional) Units corresponding to each element in propnames. Will be used by get_unit(), but this function is very tolerant More...

Property	flag_perc

Property	idx_default
	Index of property to be used by the get_rate() method. More...

Property	flag_inc_t
	=1. Whether to increment time whenever something is recorded More...

Property	t
	"Time", incremented every time `record()` is called. Reset to zero if `allocate()` is called. More...

Property	title

Property	color

Protected Member Functions
function	get_collabels (in o)
	Returns cell of strings for table header. More...

function	do_allocate (in o, in tt)

function	do_get_report (in o)
	Default report. More...

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

Protected Attributes
Property	propvalues
	Classifier's relevant properties. This is a structure array ((fields))x(time) More...

Property	flag_allocated
	Whether `allocate()` has been called. More...

Property	no_slots
	Number of allocated slots (call to allocate()) More...

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...

Constructor & Destructor Documentation

function ttlog_props::ttlog_props ( )

Member Function Documentation

function ttlog::allocate	(	in	o,
		in	tt
	)

inherited

Called to pre-allocate matrices after classlabels and rowlabels are set.

function ttlog_props::do_allocate	(	in	o,
		in	tt
	)

protected

function irobj::do_get_html ( in o )

protectedinherited

Abstract. HTML inner body.

function irobj::do_get_report ( in o )

protectedinherited

Default report.

function ttlog_props::extract_dataset ( in o )

Generates one dataset with columns being propnames.

function ttlog::extract_datasets ( in o )

inherited

Abstract. Generates one dataset per row, containing percentages.

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 ttlog_props::get_collabels ( in o )

protected

Returns cell of strings for table header.

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 ttlog_props::get_flag_perc ( in o )

Returns whether the value returned by get_rate() is a percentage or not.

function ttlog::get_format ( in o )

inherited

Returns format for sprintf()

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

inherited

Parameters

flag_stylesheet=1 Whether to include the stylesheet in the HTML

function ttlog_props::get_insane_html	(	in	o,
		in	pars
	)

function ttlog_props::get_legend ( in o )

Returns string

Returns property name specified by ttlog_props::idx_default. The title property can also be used. If the ttlog's title is a string, will return the title instead

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 ttlog_props::get_rate ( in o )

Returns average recorded value for the property specified by ttlog_props::idx_default Pleas note that the name "rate" is unlikely to be the best denomination of what is actually returned (more likely to be time, or number of rules etc). Of course, the name makes more sense in the estlog class

function ttlog_props::get_rates ( in o )

Returns all recorded values of property specified by ttlog_props::idx_default.

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 ttlog_props::get_unit ( in o )

function ttlog_props::get_X	(	in	o,
		in	aggr
	)

Returns recorded information.

Each column corresponds to a different property.

Parameters

aggr	See below Aggregation: `0` - INVALID `1` - Sum `2` - INVALID `3` - Mean `4` - Standard Deviation `5` - Minimum `6` - Maximum

function ttlog_props::record	(	in	o,
		in	pars
	)

Parameters

pars	Structure with a .clssr field.

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.

Property ttlog::flag_allocated

protectedinherited

Whether allocate() has been called.

Definition at line 16 of file ttlog.m.

Property ttlog::flag_inc_t

inherited

=1. Whether to increment time whenever something is recorded

Definition at line 10 of file ttlog.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 ttlog_props::flag_perc

(Vector of booleans, same size of ttlog_props::propnames). Whether the properties represent percentages or not. If this property is not assigned properly, 0 will be assumed whenever there is a lack of information.

Definition at line 15 of file ttlog_props.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 ttlog_props::idx_default

Index of property to be used by the get_rate() method.

Definition at line 18 of file ttlog_props.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 ttlog::no_slots

protectedinherited

Number of allocated slots (call to allocate())

Definition at line 19 of file ttlog.m.

Property ttlog_props::propnames

Properties to record.

Definition at line 8 of file ttlog_props.m.

Property ttlog_props::propunits

(Optional) Units corresponding to each element in propnames. Will be used by get_unit(), but this function is very tolerant

Definition at line 11 of file ttlog_props.m.

Property ttlog_props::propvalues

protected

Classifier's relevant properties. This is a structure array ((fields))x(time)

Definition at line 24 of file ttlog_props.m.

Property irobj::short

protectedinherited

Short for the method name.

Definition at line 53 of file irobj.m.

Property ttlog::t

inherited

"Time", incremented every time record() is called. Reset to zero if allocate() is called.

Definition at line 33 of file ttlog.m.

Property irobj::title

inherited

Definition at line 38 of file irobj.m.

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

ttlog_props.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation