MHEG5  18.9.0
MHEG5 Documentation
Functions
mh5object.c File Reference

Implement functions to retrieve MHEG5objects by GroupID and ID. There are also functions for standarizing several GroupIDs like 'DSM://' '~/' 'DSM:/'. More...

#include "mh5object.h"
#include "mh5gate.h"
#include "mh5application.h"
#include "mh5scene.h"
#include "mh5variable.h"
#include "mh5stream.h"
#include "mh5memory.h"
#include "mh5profile.h"
#include "mh5debug.h"

Go to the source code of this file.

Functions

MHEG5String MHEG5getGroupId (MHEG5Root *root)
 <Function description>=""> More...
 
MHEG5RootMHEG5findObject (MH5GroupRef gref, MHEG5Int id)
 
MHEG5GListMHEG5resolveORef (MHEG5GList *params, MHEG5Root **object)
 
MHEG5GListMHEG5resolveGenericORefProper (MHEG5GList *params, MH5GroupRef *pgroupRef, MHEG5Int *id)
 Resolve a generic object reference, returning the object reference. The reference can be direct or indirect. This function is similar to MHEG5resolveGenericORef, except that the object reference itself is returned (pgroupRef + Id), rather than the object that it points to. More...
 
MHEG5RootMHEG5resolveRealObject (MHEG5Root *objref)
 
MHEG5GListMHEG5resolveGenericORef (MHEG5GList *params, MHEG5Root **object)
 
MHEG5GListMHEG5resolveGenericCRef (MHEG5GList *params, MHEG5String *data, MHEG5Bool *referenced, MHEG5Bool *valid)
 
MHEG5GListMHEG5resolveGenericGeneric (MHEG5GList *params, MHEG5Generic *value)
 
MHEG5GListMHEG5resolveGenericBoolean (MHEG5GList *params, MHEG5Bool *value)
 
MHEG5GListMHEG5resolveGenericOctetString (MHEG5GList *params, MHEG5String *value, MHEG5Bool *invalidString)
 Resolve a parameter reference to a generic octet string. The reference can be either direct or indirect. More...
 
MHEG5GListMHEG5resolveGenericInteger (MHEG5GList *params, MHEG5Int *value)
 

Detailed Description

Implement functions to retrieve MHEG5objects by GroupID and ID. There are also functions for standarizing several GroupIDs like 'DSM://' '~/' 'DSM:/'.

Date
01/02/2002
Author
R.Freeman

Definition in file mh5object.c.

Function Documentation

MHEG5Root* MHEG5findObject ( MH5GroupRef  gref,
MHEG5Int  id 
)

Definition at line 65 of file mh5object.c.

MHEG5String MHEG5getGroupId ( MHEG5Root root)

<Function description>="">

Returns
<Return value>="">

Definition at line 56 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericBoolean ( MHEG5GList params,
MHEG5Bool value 
)

Definition at line 454 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericCRef ( MHEG5GList params,
MHEG5String data,
MHEG5Bool referenced,
MHEG5Bool valid 
)

Definition at line 299 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericGeneric ( MHEG5GList params,
MHEG5Generic value 
)

Definition at line 364 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericInteger ( MHEG5GList params,
MHEG5Int value 
)

Definition at line 510 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericOctetString ( MHEG5GList params,
MHEG5String value,
MHEG5Bool invalidString 
)

Resolve a parameter reference to a generic octet string. The reference can be either direct or indirect.

Parameters
paramsList of parameters. The first parameter in this list is parsed and a pointer to the next parameter in the list is returned by the function.
valueResolved octet string
invalidStringTrue if the next parameter was not a valid octet string, otherwise False.
Returns
Pointer to the next parameter in the parameter list, or NULL if no more parameters.

Definition at line 478 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericORef ( MHEG5GList params,
MHEG5Root **  object 
)

Definition at line 281 of file mh5object.c.

MHEG5GList* MHEG5resolveGenericORefProper ( MHEG5GList params,
MH5GroupRef pgroupRef,
MHEG5Int id 
)

Resolve a generic object reference, returning the object reference. The reference can be direct or indirect. This function is similar to MHEG5resolveGenericORef, except that the object reference itself is returned (pgroupRef + Id), rather than the object that it points to.

Resolve a generic object reference, returning the object reference. The reference can be direct or indirect. This function is similar to MHEG5resolveGenericORef, except that the object reference itself is returned (groupId + Id), rather than the object that it points to.

Parameters
paramsList of parameters. The first parameter in this list is parsed and a pointer to the next parameter in the list is returned by the function.
pgroupRefGroup of the generic object reference that is resolved.
idID of the generic object reference that is resolved.
Returns
Pointer to the next parameter in the parameter list, or NULL if no more parameters.

Definition at line 177 of file mh5object.c.

MHEG5GList* MHEG5resolveORef ( MHEG5GList params,
MHEG5Root **  object 
)

Definition at line 126 of file mh5object.c.

MHEG5Root* MHEG5resolveRealObject ( MHEG5Root objref)

Definition at line 254 of file mh5object.c.