| synopsis || return value || arguments || prev || next |
kdu_params * link( kdu_params * existing, int tile_idx, int comp_idx)
Java: Kdu_params Link( Kdu_params existing, int tile_idx, int comp_idx)
[Declared in "../coresys/common/kdu_params.h"]
Links the object into a list of existing object clusters, of which existing must be a member. In the process, the tile index and component index of the new object are replaced by the supplied values. Upon initial construction, kdu_params objects are configured as cluster heads, with tile and component indices of -1 and instance index of 0. If the existing list of clusters already contains an instance with the same cluster name and identical tile and component indices to those supplied here, the instance index will automatically be incremented to the next available one for that tile-component. If multiple instances are disallowed by the derived parameter class, an appropriate error will be generated.
Returns a pointer to itself (the this) pointer, as a convenience for some statement constructions.
Pointer to any member (usually, but not necessarily a cluster head) of an existing list of clusters, into which the current object is to be linked.
New value to use for the tile index — upon construction, objects will normally have a tile index of -1. The value supplied here should be in the range 0 to num_tiles-1 for tile-specific members of the cluster, or -1 for cluster heads and component- but not tile-specific default objects.
New value to use for the component index — upon construction, objects will normally have a component index of -1. The value supplied here should be in the range 0 to num_comps-1 for component-specific members of the cluster, or -1 for cluster and tile heads.
| top || synopsis || return value || arguments || prev || next |