histogram

Modules
	Loadshape
	Schedule
Functions
EXPORT int	create_histogram (OBJECT **obj, OBJECT *parent)
	REQUIRED: allocate and initialize an object.
int	histogram::init (OBJECT *parent)
	Object initialization is called once after all object have been created.
EXPORT int	isa_histogram (OBJECT *obj, char *classname)
	Allows the core to discover whether obj is a subtype of this class.
int	parse_bin_val (char *tok, BIN *bin)
	Token parsing to extract bin range.
void	histogram::test_for_complex (char *, char *)
	Local convenience function, used to extract the complex part of a property string (if any) and add a null character to the property string accordingly.

---

Function Documentation

EXPORT int create_histogram	(	OBJECT **	obj,
		OBJECT *	parent
	)

REQUIRED: allocate and initialize an object.

Parameters:

	obj	a pointer to a pointer of the last object in the list
	parent	a pointer to the parent of this object

Returns:

1 for a successfully created object, 0 for error

Definition at line 554 of file histogram.cpp.

int histogram::init

(

OBJECT *

parent

)

[inherited]

Object initialization is called once after all object have been created.

Parameters:

parent

a pointer to this object's parent

Returns:

1 on success, 0 on error

Definition at line 215 of file histogram.cpp.

References parse_bin_val().

EXPORT int isa_histogram	(	OBJECT *	obj,
		char *	classname
	)

Allows the core to discover whether obj is a subtype of this class.

Parameters:

	obj	a pointer to this object
	classname	the name of the object the core is testing

Returns:

true (1) if obj is a subtype of this class

Definition at line 610 of file histogram.cpp.

int parse_bin_val	(	char *	tok,
		BIN *	bin
	)

Token parsing to extract bin range.

Returns:

0 on error

Definition at line 96 of file histogram.cpp.

Referenced by histogram::init().

void histogram::test_for_complex	(	char *	tprop,
		char *	tpart
	)			[protected, inherited]

Local convenience function, used to extract the complex part of a property string (if any) and add a null character to the property string accordingly.

Parameters:

	tprop	a pointer to the buffer for the property name
	tpart	a pointer to the buffer for the property complex type

Definition at line 193 of file histogram.cpp.

References NONE.