Attribute Module
[Jitter]

Collaboration diagram for Attribute Module:

Data Structures
struct	t_jit_attribute
	t_jit_attribute object struct. More...
struct	t_jit_attr_offset
	t_jit_attr_offset object struct. More...
struct	t_jit_attr_offset_array
	t_jit_attr_offset_array object struct. More...
struct	t_jit_attr_filter_clip
	t_jit_attr_filter_clip object struct. More...
struct	t_jit_attr_filter_proc
	t_jit_attr_filter_proc object struct. More...
struct	t_jit_attr
	Common attribute struct. More...
Functions
t_symbol *	jit_attr_getname (t_jit_attr *x)
	Retrieves attribute name.
t_symbol *	jit_attr_gettype (t_jit_attr *x)
	Retrieves attribute type.
long	jit_attr_canget (t_jit_attr *x)
	Retrieves attribute gettable flag.
long	jit_attr_canset (t_jit_attr *x)
	Retrieves attribute settable flag.
long	jit_attr_usercanget (t_jit_attr *x)
	Retrieves attribute user gettable flag.
long	jit_attr_usercanset (t_jit_attr *x)
	Retrieves attribute user settable flag.
method	jit_attr_getmethod (t_jit_attr *x, t_symbol *methodname)
	Retrieves attribute getter or setter method.
t_jit_err	jit_attr_filterget (t_jit_attr *x, void *y)
	Sets attribute getter filter.
t_jit_err	jit_attr_filterset (t_jit_attr *x, void *y)
	Sets attribute setter filter.
t_jit_err	jit_attr_get (t_jit_attr *x, void *parent, long *ac, t_atom **av)
	Calls attribute getter to retrieve from parent object.
t_jit_err	jit_attr_set (t_jit_attr *x, void *parent, long ac, t_atom *av)
	Calls attribute setter to set in parent object.
t_jit_object *	jit_attribute_new (char *name, t_symbol *type, long flags, method mget, method mset)
	Constructs instance of t_jit_attribute.
t_jit_object *	jit_attr_offset_new (char *name, t_symbol *type, long flags, method mget, method mset, long offset)
	Constructs instance of t_jit_attr_offset.
t_jit_object *	jit_attr_offset_array_new (char *name, t_symbol *type, long size, long flags, method mget, method mset, long offsetcount, long offset)
	Constructs instance of t_jit_attr_offset_array.
t_jit_object *	jit_attr_filter_clip_new (void)
	Constructs instance of t_jit_attr_filter_clip.
t_jit_object *	jit_attr_filter_proc_new (method proc)
	Constructs instance of t_jit_attr_filter_proc.
long	jit_attr_getlong (void *x, t_symbol *s)
	Retrieves attribute value as a long integer value.
t_jit_err	jit_attr_setlong (void *x, t_symbol *s, long c)
	Sets attribute value as a long integer value.
float	jit_attr_getfloat (void *x, t_symbol *s)
	Retrieves attribute value as a floating point value.
t_jit_err	jit_attr_setfloat (void *x, t_symbol *s, float c)
	Sets attribute value as a floating point value.
t_symbol *	jit_attr_getsym (void *x, t_symbol *s)
	Retrieves attribute value as a symbol value.
t_jit_err	jit_attr_setsym (void *x, t_symbol *s, t_symbol *c)
	Sets attribute value as a symbol value.
long	jit_attr_getlong_array (void *x, t_symbol *s, long max, long *vals)
	Retrieves attribute value as an array of long integer values.
t_jit_err	jit_attr_setlong_array (void *x, t_symbol *s, long count, long *vals)
	Sets attribute value as an array of long integer values.
long	jit_attr_getchar_array (void *x, t_symbol *s, long max, uchar *vals)
	Retrieves attribute value as an array of char values.
t_jit_err	jit_attr_setchar_array (void *x, t_symbol *s, long count, uchar *vals)
	Sets attribute value as an array of char values.
long	jit_attr_getfloat_array (void *x, t_symbol *s, long max, float *vals)
	Retrieves attribute value as an array of floating point values.
t_jit_err	jit_attr_setfloat_array (void *x, t_symbol *s, long count, float *vals)
	Sets attribute value as an array of floating point values.
long	jit_attr_getdouble_array (void *x, t_symbol *s, long max, double *vals)
	Retrieves attribute value as an array of double precision floating point values.
t_jit_err	jit_attr_setdouble_array (void *x, t_symbol *s, long count, double *vals)
	Sets attribute value as an array of double precision floating point values.
long	jit_attr_getsym_array (void *x, t_symbol *s, long max, t_symbol **vals)
	Retrieves attribute value as an array of symbol values.
t_jit_err	jit_attr_setsym_array (void *x, t_symbol *s, long count, t_symbol **vals)
	Sets attribute value as an array of symbol values.
long	jit_attr_symcompare (void *x, t_symbol *name)
	Compares symbol name with name provided.

---

Function Documentation

long jit_attr_canget

(

t_jit_attr *

x

)

Retrieves attribute gettable flag.

Parameters:

x

attribute object pointer

Returns:

gettable flag

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

long jit_attr_canset

(

t_jit_attr *

x

)

Retrieves attribute settable flag.

Parameters:

x

attribute object pointer

Returns:

settable flag

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_jit_object * jit_attr_filter_clip_new

(

void

)

Constructs instance of t_jit_attr_filter_clip.

Returns:

t_jit_attr_filter_clip object pointer

Warning:

This function is not exported, but is provided for reference when calling via jit_object_new.

t_jit_object * jit_attr_filter_proc_new

(

method

proc

)

Constructs instance of t_jit_attr_filter_proc.

Parameters:

proc

filter procedure

Returns:

t_jit_attr_filter_clip object pointer

Warning:

This function is not exported, but is provided for reference when calling via jit_object_new.

t_jit_err jit_attr_filterget	(	t_jit_attr *	x,
		void *	y
	)

Sets attribute getter filter.

Parameters:

	x	attribute object pointer
	y	getter filter object

Returns:

t_jit_err error code

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_jit_err jit_attr_filterset	(	t_jit_attr *	x,
		void *	y
	)

Sets attribute setter filter.

Parameters:

	x	attribute object pointer
	y	setter filter object

Returns:

t_jit_err error code

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_jit_err jit_attr_get	(	t_jit_attr *	x,
		void *	parent,
		long *	ac,
		t_atom **	av
	)

Calls attribute getter to retrieve from parent object.

Parameters:

	x	attribute object pointer
	parent	target object pointer
	ac	pointer to argument count
	av	pointer to argument vector

Returns:

t_jit_err error code

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

long jit_attr_getchar_array	(	void *	x,
		t_symbol *	s,
		long	max,
		uchar *	vals
	)

Retrieves attribute value as an array of char values.

Parameters:

	x	object pointer
	s	attribute name
	max	maximum number of values to copy
	vals	pointer to retrieved values

Returns:

number of values retrieved.

long jit_attr_getdouble_array	(	void *	x,
		t_symbol *	s,
		long	max,
		double *	vals
	)

Retrieves attribute value as an array of double precision floating point values.

Parameters:

	x	object pointer
	s	attribute name
	max	maximum number of values to copy
	vals	pointer to retrieved values

Returns:

number of values retrieved.

float jit_attr_getfloat	(	void *	x,
		t_symbol *	s
	)

Retrieves attribute value as a floating point value.

Parameters:

	x	object pointer
	s	attribute name

Returns:

floating point value

long jit_attr_getfloat_array	(	void *	x,
		t_symbol *	s,
		long	max,
		float *	vals
	)

Retrieves attribute value as an array of floating point values.

Parameters:

	x	object pointer
	s	attribute name
	max	maximum number of values to copy
	vals	pointer to retrieved values

Returns:

number of values retrieved.

long jit_attr_getlong	(	void *	x,
		t_symbol *	s
	)

Retrieves attribute value as a long integer value.

Parameters:

	x	object pointer
	s	attribute name

Returns:

long integer value

long jit_attr_getlong_array	(	void *	x,
		t_symbol *	s,
		long	max,
		long *	vals
	)

Retrieves attribute value as an array of long integer values.

Parameters:

	x	object pointer
	s	attribute name
	max	maximum number of values to copy
	vals	pointer to retrieved values

Returns:

number of values retrieved.

method jit_attr_getmethod	(	t_jit_attr *	x,
		t_symbol *	methodname
	)

Retrieves attribute getter or setter method.

Parameters:

	x	attribute object pointer
	methodname	"get" or "set" symbol

Returns:

getter or setter method

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_symbol * jit_attr_getname

(

t_jit_attr *

x

)

Retrieves attribute name.

Parameters:

x

attribute object pointer

Returns:

attribute name

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_symbol* jit_attr_getsym	(	void *	x,
		t_symbol *	s
	)

Retrieves attribute value as a symbol value.

Parameters:

	x	object pointer
	s	attribute name

Returns:

symbol value

long jit_attr_getsym_array	(	void *	x,
		t_symbol *	s,
		long	max,
		t_symbol **	vals
	)

Retrieves attribute value as an array of symbol values.

Parameters:

	x	object pointer
	s	attribute name
	max	maximum number of values to copy
	vals	pointer to retrieved values

Returns:

number of values retrieved.

t_symbol * jit_attr_gettype

(

t_jit_attr *

x

)

Retrieves attribute type.

Parameters:

x

attribute object pointer

Returns:

attribute type

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_jit_object * jit_attr_offset_array_new	(	char *	name,
		t_symbol *	type,
		long	size,
		long	flags,
		method	mget,
		method	mset,
		long	offsetcount,
		long	offset
	)

Constructs instance of t_jit_attr_offset_array.

Parameters:

	name	attribute name
	type	data type
	size	maximum size
	flags	privacy flags
	mget	getter method
	mset	setter method
	offsetcount	byte offset to count struct member (if zero, remain fixed size with max size)
	offset	byte offset to array struct member

Returns:

t_jit_attr_offset_array object pointer

Warning:

This function is not exported, but is provided for reference when calling via jit_object_new.

t_jit_object * jit_attr_offset_new	(	char *	name,
		t_symbol *	type,
		long	flags,
		method	mget,
		method	mset,
		long	offset
	)

Constructs instance of t_jit_attr_offset.

Parameters:

	name	attribute name
	type	data type
	flags	privacy flags
	mget	getter method
	mset	setter method
	offset	byte offset to struct member

Returns:

t_jit_attr_offset object pointer

Warning:

This function is not exported, but is provided for reference when calling via jit_object_new.

t_jit_err jit_attr_set	(	t_jit_attr *	x,
		void *	parent,
		long	ac,
		t_atom *	av
	)

Calls attribute setter to set in parent object.

Parameters:

	x	attribute object pointer
	parent	target object pointer
	ac	argument count
	av	argument vector

Returns:

t_jit_err error code

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_jit_err jit_attr_setchar_array	(	void *	x,
		t_symbol *	s,
		long	count,
		uchar *	vals
	)

Sets attribute value as an array of char values.

Parameters:

	x	object pointer
	s	attribute name
	count	number of values
	vals	pointer to values

Returns:

t_jit_err error code.

t_jit_err jit_attr_setdouble_array	(	void *	x,
		t_symbol *	s,
		long	count,
		double *	vals
	)

Sets attribute value as an array of double precision floating point values.

Parameters:

	x	object pointer
	s	attribute name
	count	number of values
	vals	pointer to values

Returns:

t_jit_err error code.

t_jit_err jit_attr_setfloat	(	void *	x,
		t_symbol *	s,
		float	c
	)

Sets attribute value as a floating point value.

Parameters:

	x	object pointer
	s	attribute name
	c	value

Returns:

t_jit_err error code.

t_jit_err jit_attr_setfloat_array	(	void *	x,
		t_symbol *	s,
		long	count,
		float *	vals
	)

Sets attribute value as an array of floating point values.

Parameters:

	x	object pointer
	s	attribute name
	count	number of values
	vals	pointer to values

Returns:

t_jit_err error code.

t_jit_err jit_attr_setlong	(	void *	x,
		t_symbol *	s,
		long	c
	)

Sets attribute value as a long integer value.

Parameters:

	x	object pointer
	s	attribute name
	c	value

Returns:

t_jit_err error code.

t_jit_err jit_attr_setlong_array	(	void *	x,
		t_symbol *	s,
		long	count,
		long *	vals
	)

Sets attribute value as an array of long integer values.

Parameters:

	x	object pointer
	s	attribute name
	count	number of values
	vals	pointer to values

Returns:

t_jit_err error code.

t_jit_err jit_attr_setsym	(	void *	x,
		t_symbol *	s,
		t_symbol *	c
	)

Sets attribute value as a symbol value.

Parameters:

	x	object pointer
	s	attribute name
	c	value

Returns:

t_jit_err error code.

t_jit_err jit_attr_setsym_array	(	void *	x,
		t_symbol *	s,
		long	count,
		t_symbol **	vals
	)

Sets attribute value as an array of symbol values.

Parameters:

	x	object pointer
	s	attribute name
	count	number of values
	vals	pointer to values

Returns:

t_jit_err error code.

long jit_attr_symcompare	(	void *	x,
		t_symbol *	name
	)

Compares symbol name with name provided.

Parameters:

	x	attribute object pointer
	name	attribute name

Returns:

1 if equal, 0 if not equal

long jit_attr_usercanget

(

t_jit_attr *

x

)

Retrieves attribute user gettable flag.

Parameters:

x

attribute object pointer

Returns:

user gettable flag

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

long jit_attr_usercanset

(

t_jit_attr *

x

)

Retrieves attribute user settable flag.

Parameters:

x

attribute object pointer

Returns:

user settable flag

Warning:

This function is not exported, but is provided for reference when calling via jit_object_method on an intance of any attribute obejct.

t_jit_object * jit_attribute_new	(	char *	name,
		t_symbol *	type,
		long	flags,
		method	mget,
		method	mset
	)

Constructs instance of t_jit_attribute.

Parameters:

	name	attribute name
	type	data type
	flags	privacy flags
	mget	getter method
	mset	setter method

Returns:

t_jit_attribute object pointer

Warning:

This function is not exported, but is provided for reference when calling via jit_object_new.