StringParameter Class Reference

The parameter represents an untyped value which is stored in a char_t string. More...

#include <avb.h>

Inheritance diagram for StringParameter:

Public Member Functions
virtual bool_t	setValue (const char_t *value)=0
	Sets the parameter value.
virtual const char_t *	value () const =0
	Returns the parameter value.
Public Member Functions inherited from Parameter
virtual Parameter *	clone () const =0
	Creates a deep copy of the underlying StringParameter, IntParameter, FloatParameter, or MediaBufferParameter object.
virtual const char *	name () const =0
	Returns the parameter name.
virtual bool_t	setName (const char *name)=0
	Sets the parameter name.
virtual ParamType::Enum	type () const =0
	Returns the parameter type.
Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance.
virtual int32_t	retain () const =0
	Retains the instance.
virtual int32_t	retainCount () const =0
	Returns the current reference count.

Additional Inherited Members
Protected Member Functions inherited from Parameter
	~Parameter ()
	This object can be destroyed only by the AVBlocks library.

Detailed Description

The parameter represents an untyped value which is stored in a char_t string.

The parameter name constant documents how this value should be interpreted.

Member Function Documentation

setValue()

virtual bool_t setValue ( const char_t *  value )

pure virtual

Sets the parameter value.

Parameters

value

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

value()

virtual const char_t * value ( ) const

pure virtual

Returns the parameter value.

Returns

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