ParameterList Class Reference

A collection of Parameter objects. More...

Inherits Reference.

List of all members.

Public Member Functions
virtual void	add (Parameter *item)=0
	Adds a parameter to the collection.
virtual bool_t	remove (int32_t itemIndex)=0
	Removes a parameter from the collection.
virtual void	clear ()=0
	Removes all parameters from the collection.
virtual int32_t	count () const =0
	Returns the number of parameters in the collection.
virtual Parameter *	at (int32_t index) const =0
	Returns a parameter specified by index.
virtual Parameter *	itemByName (const char *name) const =0
	Returns a parameter specified by its name.
virtual bool_t	setAt (int32_t itemIndex, Parameter *item)=0
	Sets a new parameter at the specified index.
virtual bool_t	insert (int32_t itemIndex, Parameter *item)=0
	Inserts a parameter at the specified index.
Protected Member Functions
	~ParameterList ()
	This object can be destroyed only by the AVBlocks library.

---

Detailed Description

A collection of Parameter objects.

It is used for passing parameters to different AVBlocks components.

See also:

Parameter

Library::createParameterList

---

Member Function Documentation

virtual void add

(

Parameter *

item

)

[pure virtual]

Adds a parameter to the collection.

Parameters:

item	[in] A pointer to a Parameter object that should be added to the collection. It is allowed to add a NULL item to the collection. Internally if the Parameter object is not NULL it is retained by ParameterList, so it is safe to release it after this method returns.

See also:

Library::createParameter

Object Management Topic

virtual Parameter* at

(

int32_t

index

)

const [pure virtual]

Returns a parameter specified by index.

Parameters:

index

[in] The index of the parameter to be returned. Indexing starts from 0.

Returns:

A pointer to the Parameter object specified by index or NULL if the index is invalid.

The caller is not required to release the returned object.

See also:

Object Management

virtual void clear

(

)

[pure virtual]

Removes all parameters from the collection.

When removed from the collection each Parameter object is released.

See also:

Object Management

virtual int32_t count

(

)

const [pure virtual]

Returns the number of parameters in the collection.

Returns:

number of items in the collection.

virtual bool_t insert	(	int32_t	itemIndex,
		Parameter *	item
	)		[pure virtual]

Inserts a parameter at the specified index.

Parameters:

itemIndex	[in] The index in the collection where the new item shall be inserted. This must be a valid index in the collection. Indexing starts from 0. After the new item is inserted in the collection its index is the value of the itemIndex param.
item	[in] A pointer to the Parameter object that shall be inserted. It is allowed to insert a NULL value in the collection. Internally the new item is retained (if not NULL), so it is safe to release it after this method returns.

Returns:

TRUE The item is set, FALSE otherwise.

See also:

Object Management

virtual Parameter* itemByName

(

const char *

name

)

const [pure virtual]

Returns a parameter specified by its name.

Parameters:

name	[in] A pointer to a parameter name for which a Parameter object shall be returned. The name is case sensitive and only the first 64 characters are compared.

Returns:

A pointer to a Parameter object which has the name specified by the name parameter. NULL if there's no parameter with the specified name in the collection.

If two or more parameters in the collection have the same name the one with the lowest index is returned.

virtual bool_t remove

(

int32_t

itemIndex

)

[pure virtual]

Removes a parameter from the collection.

Parameters:

itemIndex

[in] The index of the parameter that should be removed from the collection. Indexing starts from 0.

Returns:

TRUE if the specified item is removed from the collection, otherwise FALSE.

When a Parameter object is removed from the collection it is also released.

See also:

Object Management

virtual bool_t setAt	(	int32_t	itemIndex,
		Parameter *	item
	)		[pure virtual]

Sets a new parameter at the specified index.

Parameters:

itemIndex	[in] The index in the collection where the new item shall be set. This must be a valid index in the collection. Indexing starts from 0.
item	[in] A pointer to the Parameter object that shall be set. It is allowed to set a NULL value to the collection. Internally the new item is retained (if not NULL), so it is safe to release it after this method returns. The old item is released (if not NULL).

Returns:

TRUE The item is set, FALSE otherwise.

See also:

Object Management