Parameter Class Reference

Parameter is the base class for named parameters passed to various classes in AVBlocks. More...

Inherits Reference.

Inherited by ByteArrayParameter, FloatParameter, IntParameter, MediaBufferParameter, and StringParameter.

List of all members.

Public Member Functions
virtual const char *	name () const =0
	Returns the parameter name.
virtual void	setName (const char *name)=0
	Sets the parameter name.
virtual ParamType::Enum	type () const =0
	Returns the parameter type.
Protected Member Functions
	~Parameter ()
	This object can be destroyed only by the AVBlocks library.

---

Detailed Description

Parameter is the base class for named parameters passed to various classes in AVBlocks.

The parameter name is an ANSI string. The parameter content can be a simple value or a complex structure. This is determined by the parameter type.

---

Member Function Documentation

virtual const char* name

(

)

const [pure virtual]

Returns the parameter name.

Returns:

A pointer to zero terminated ANSI string. The returned pointer cannot be NULL but the string can be empty.

virtual void setName

(

const char *

name

)

[pure virtual]

Sets the parameter name.

Parameters:

name	[in] A pointer to zero terminated ANSI string. If NULL it is interpreted as if an empty string is provided. The string pointed by name is copied internally and is not required to be valid after the method returns.

virtual ParamType::Enum type

(

)

const [pure virtual]

Returns the parameter type.

Returns:

A ParamType constant.