source/classes/inc/mh5variable.h File Reference

Implement the MHEG5 Variable Class 21 Variable Class Defines a variable within the context of a Group object. Base class: Ingredient Subclasses: BooleanVariable, IntegerVariable, OctetStringVariable, ObjectReferenceVariable, ContentRefVariable Status: Abstract class. More...

#include "mh5ingredient.h"

Go to the source code of this file.

Data Structures
struct	MHEG5BooleanVariable
struct	MHEG5IntegerVariable
struct	MHEG5OctetStringVariable
struct	MHEG5ObjectRefVariable
struct	MHEG5ContentVariable
Functions
void	MHEG5booleanVariableInit (MHEG5BooleanVariable *variable)
	<Function description>="">
void	MHEG5booleanVariablePrepare (MHEG5BooleanVariable *variable)
	Sets all internal attributes for the specified object to their default values.
void	MHEG5booleanVariableFree (MHEG5BooleanVariable *variable)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5integerVariableInit (MHEG5IntegerVariable *variable)
	Initialise a integerVariable object with default values.
void	MHEG5integerVariablePrepare (MHEG5IntegerVariable *variable)
	Sets all internal attributes for the specified object to their default values.
void	MHEG5integerVariableFree (MHEG5IntegerVariable *variable)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5octetStringVariableInit (MHEG5OctetStringVariable *variable)
	Initialise an octetStringVariable object with default values.
void	MHEG5octetStringVariablePrepare (MHEG5OctetStringVariable *variable)
	Sets all internal attributes for the specified object to their default values.
void	MHEG5octetStringVariableFree (MHEG5OctetStringVariable *variable)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5octetStringVariableDestruct (MHEG5OctetStringVariable *variable)
void	MHEG5objectRefVariableInit (MHEG5ObjectRefVariable *variable)
	Initialise an objectRefVariable object with default values.
void	MHEG5objectRefVariablePrepare (MHEG5ObjectRefVariable *variable)
	Sets all internal attributes for the specified object to their default values.
void	MHEG5objectRefVariableFree (MHEG5ObjectRefVariable *variable)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5contentVariableInit (MHEG5ContentVariable *variable)
	Initialise a contentVariable object with default values.
void	MHEG5contentVariablePrepare (MHEG5ContentVariable *variable)
	Sets all internal attributes for the specified object to their default values.
void	MHEG5contentVariableFree (MHEG5ContentVariable *variable)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5contentVariableDestruct (MHEG5ContentVariable *variable)
void	MHEG5objRefStoreValue (MHEG5ObjectRefVariable *objRef, MH5GroupRef ref, MHEG5Int id)
void	MHEG5objRefStoreString (MHEG5ObjectRefVariable *objRef, MHEG5String ref, MHEG5Int id)
void	MHEG5variablePrepare (MHEG5Ingredient *variable)
void	MHEG5variableActivate (MHEG5Ingredient *variable)
void	MHEG5variableDeactivate (MHEG5Ingredient *variable)
void	MHEG5variableDestruct (MHEG5Ingredient *variable)
MHEG5ErrorCode	MHEG5setVariable (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5testVariable (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5add (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5subtract (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5multiply (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5divide (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5modulo (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5append (MHEG5Root *target, MHEG5GList *params)
MHEG5Int	MHEG5variableStore (MHEG5Ingredient *v, void *buf, MHEG5Int bufLen)
MHEG5Int	MHEG5variableRead (MHEG5Ingredient *v, char *buf, MHEG5Int max_size)

---

Detailed Description

Implement the MHEG5 Variable Class 21 Variable Class Defines a variable within the context of a Group object. Base class: Ingredient Subclasses: BooleanVariable, IntegerVariable, OctetStringVariable, ObjectReferenceVariable, ContentRefVariable Status: Abstract class.

Date:

05/02/2202

Author:

R.Freeman

---

Function Documentation

void MHEG5booleanVariableFree

(

MHEG5BooleanVariable *

variable

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

variable

Pointer to object to free.

Returns:

Void

void MHEG5booleanVariableInit

(

MHEG5BooleanVariable *

variable

)

<Function description>="">

Returns:

<Return value>=""> Initialise a booleanVariable object with default values.

Parameters:

variable

Pointer to object to initialise.

Returns:

Void

void MHEG5booleanVariablePrepare

(

MHEG5BooleanVariable *

variable

)

Sets all internal attributes for the specified object to their default values.

Parameters:

variable

Pointer to object to initialise internal attributes for.

Returns:

Void

void MHEG5contentVariableFree

(

MHEG5ContentVariable *

variable

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

variable

Pointer to object to free.

Returns:

Void

void MHEG5contentVariableInit

(

MHEG5ContentVariable *

variable

)

Initialise a contentVariable object with default values.

Parameters:

variable

Pointer to object to initialise.

Returns:

Void

void MHEG5contentVariablePrepare

(

MHEG5ContentVariable *

variable

)

Sets all internal attributes for the specified object to their default values.

Parameters:

variable

Pointer to object to initialise internal attributes for.

Returns:

Void

void MHEG5integerVariableFree

(

MHEG5IntegerVariable *

variable

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

variable

Pointer to object to free.

Returns:

Void

void MHEG5integerVariableInit

(

MHEG5IntegerVariable *

variable

)

Initialise a integerVariable object with default values.

Parameters:

variable

Pointer to object to initialise.

Returns:

Void

void MHEG5integerVariablePrepare

(

MHEG5IntegerVariable *

variable

)

Sets all internal attributes for the specified object to their default values.

Parameters:

variable

Pointer to object to initialise internal attributes for.

Returns:

Void

void MHEG5objectRefVariableFree

(

MHEG5ObjectRefVariable *

variable

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

variable

Pointer to object to free.

Returns:

Void

void MHEG5objectRefVariableInit

(

MHEG5ObjectRefVariable *

variable

)

Initialise an objectRefVariable object with default values.

Parameters:

variable

Pointer to object to initialise.

Returns:

Void

void MHEG5objectRefVariablePrepare

(

MHEG5ObjectRefVariable *

variable

)

Sets all internal attributes for the specified object to their default values.

Parameters:

variable

Pointer to object to initialise internal attributes for.

Returns:

Void

void MHEG5octetStringVariableFree

(

MHEG5OctetStringVariable *

variable

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

variable

Pointer to object to free.

Returns:

Void

void MHEG5octetStringVariableInit

(

MHEG5OctetStringVariable *

variable

)

Initialise an octetStringVariable object with default values.

Parameters:

variable

Pointer to object to initialise.

Returns:

Void

void MHEG5octetStringVariablePrepare

(

MHEG5OctetStringVariable *

variable

)

Sets all internal attributes for the specified object to their default values.

Parameters:

variable

Pointer to object to initialise internal attributes for.

Returns:

Void