| synopsis || return value || arguments || prev || next |

kdu_params::access_cluster

Java: Kdu_params::Access_cluster

Overload navigation: 1, 2

kdu_params * access_cluster( const char * cluster_name)

Java: Kdu_params Access_cluster( String cluster_name)

[Declared in "../coresys/common/kdu_params.h"]

Go to class description.


Synopsis

Returns the cluster head of any cluster whose name matches the cluster_name argument. The function may be invoked on any member of the same multi-dimensional list structure (the same code-stream description) as the requested cluster head.


Return Value

NULL if the cluster_name cannot be matched.

Arguments

cluster_name [const char *]

Relevant cluster names are given by macros which are defined with the corresponding derived class definitions. Check the documentation for derived classes such as siz_params, cod_params, qcd_params, etc., for appropriate macro names. A full string match is performed on cluster names so it is not strictly necessary to use these macros.


| top || synopsis || return value || arguments || prev || next |