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"

Data Structures
struct	MHEG5BooleanVariable

struct	MHEG5IntegerVariable

struct	MHEG5OctetStringVariable

struct	MHEG5ObjectRefVariable

struct	MHEG5ContentVariable

Functions
void	MHEG5booleanVariableInit (MHEG5BooleanVariable *variable)
	<Function description>=""> More...

void	MHEG5booleanVariablePrepare (MHEG5BooleanVariable *variable)
	Sets all internal attributes for the specified object to their default values. More...

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. More...

void	MHEG5integerVariableInit (MHEG5IntegerVariable *variable)
	Initialise a integerVariable object with default values. More...

void	MHEG5integerVariablePrepare (MHEG5IntegerVariable *variable)
	Sets all internal attributes for the specified object to their default values. More...

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. More...

void	MHEG5octetStringVariableInit (MHEG5OctetStringVariable *variable)
	Initialise an octetStringVariable object with default values. More...

void	MHEG5octetStringVariablePrepare (MHEG5OctetStringVariable *variable)
	Sets all internal attributes for the specified object to their default values. More...

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. More...

void	MHEG5octetStringVariableDestruct (MHEG5OctetStringVariable *variable)

void	MHEG5objectRefVariableInit (MHEG5ObjectRefVariable *variable)
	Initialise an objectRefVariable object with default values. More...

void	MHEG5objectRefVariablePrepare (MHEG5ObjectRefVariable *variable)
	Sets all internal attributes for the specified object to their default values. More...

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. More...

void	MHEG5contentVariableInit (MHEG5ContentVariable *variable)
	Initialise a contentVariable object with default values. More...

void	MHEG5contentVariablePrepare (MHEG5ContentVariable *variable)
	Sets all internal attributes for the specified object to their default values. More...

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. More...

void	MHEG5contentVariableDestruct (MHEG5ContentVariable *variable)

void	MHEG5objRefStoreValue (MHEG5ObjectRefVariable *objRef, MH5GroupRef ref, MHEG5Int id)

void	MHEG5objRefStoreString (MHEG5ObjectRefVariable *objRef, MHEG5String ref, MHEG5Int id)

void	MHEG5variablePrepare (MHEG5Ingredient *variable)
	Apply the preparation behaviour of the variable class Apply the preparation behaviour of the variable class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class. More...

void	MHEG5variableActivate (MHEG5Ingredient *variable)
	Apply the activation behaviour of the Variable class. Apply the activation behaviour of the variable class. More...

void	MHEG5variableDeactivate (MHEG5Ingredient *variable)
	Apply the deactivation behaviour of the variable class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More...

void	MHEG5variableDestruct (MHEG5Ingredient *variable)
	Destruct a variable object. More...

MHEG5ErrorCode	MHEG5setVariable (MHEG5Root target, MHEG5GList params)
	Set the Value attribute of the Target object to NewVariableValue. Implementation of the SetVariable (NewVariableValue) action of the variable class. More...

MHEG5ErrorCode	MHEG5testVariable (MHEG5Root target, MHEG5GList params)
	This action tests variables agains each other or against values Implementation of the TestVariable (Target, Operator, ComparisonValue) action of the variable class. More...

MHEG5ErrorCode	MHEG5add (MHEG5Root target, MHEG5GList params)
	Add Target Variable to Value. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Add (Value) action of the IntegerVariable class. More...

MHEG5ErrorCode	MHEG5subtract (MHEG5Root target, MHEG5GList params)
	Subtract Value from Target Variable. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Subtract (Value) action of the IntegerVariable class. More...

MHEG5ErrorCode	MHEG5multiply (MHEG5Root target, MHEG5GList params)
	Multiplies Target Variable by Value. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Multiply (Value) action of the IntegerVariable class. More...

MHEG5ErrorCode	MHEG5divide (MHEG5Root target, MHEG5GList params)
	Divides Target Variable by Value. Target variable is the first operand of the infix operation. Result is stored in Target Variable. When the result is not an integer value, rounding is made towards 0. Implementation of the Divide (Value) action of the IntegerVariable class. More...

MHEG5ErrorCode	MHEG5modulo (MHEG5Root target, MHEG5GList params)
	Returns the remainder modulo Value of Target - as defined by usual integer arithmetic rules, that is to say that for any integers a and b the following equality is satisfied: (a DIV b) *b + (a MOD b) = a. Implementation of the Modulo (Value) action of the IntegerVariable class. More...

MHEG5ErrorCode	MHEG5append (MHEG5Root target, MHEG5GList params)
	Appends AppendValue to Target Variable. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Append (AppendValue) action of the OctetStringVariable class. More...

MHEG5Int	MHEG5variableStore (MHEG5Ingredient v, void buf, MHEG5Int bufLen)
	This functions stores the value of a variable in the persistant storage. Implementation of the StorePersistant (...) action of the variable class. More...

MHEG5Int	MHEG5variableRead (MHEG5Ingredient v, char buf, MHEG5Int max_size)
	This functions reads the value of a variable from the persistant storage. Implementation of the ReadPersistant (...) action of the variable class. More...

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

MHEG5ErrorCode MHEG5add	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Add Target Variable to Value. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Add (Value) action of the IntegerVariable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5append	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Appends AppendValue to Target Variable. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Append (AppendValue) action of the OctetStringVariable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

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 )

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

Parameters

variable Pointer to object to initialise.

Returns: Void

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

MHEG5ErrorCode MHEG5divide	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Divides Target Variable by Value. Target variable is the first operand of the infix operation. Result is stored in Target Variable. When the result is not an integer value, rounding is made towards 0. Implementation of the Divide (Value) action of the IntegerVariable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

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

MHEG5ErrorCode MHEG5modulo	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Returns the remainder modulo Value of Target - as defined by usual integer arithmetic rules, that is to say that for any integers a and b the following equality is satisfied: (a DIV b) *b + (a MOD b) = a. Implementation of the Modulo (Value) action of the IntegerVariable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5multiply	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Multiplies Target Variable by Value. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Multiply (Value) action of the IntegerVariable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

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

MHEG5ErrorCode MHEG5setVariable	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Set the Value attribute of the Target object to NewVariableValue. Implementation of the SetVariable (NewVariableValue) action of the variable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5subtract	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Subtract Value from Target Variable. Target variable is the first operand of the infix operation. Result is stored in Target Variable. Implementation of the Subtract (Value) action of the IntegerVariable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5testVariable	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

This action tests variables agains each other or against values Implementation of the TestVariable (Target, Operator, ComparisonValue) action of the variable class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

void MHEG5variableActivate ( MHEG5Ingredient * variable )

Apply the activation behaviour of the Variable class. Apply the activation behaviour of the variable class.

Parameters

MHEG5Ingredient *variable

Returns: void

void MHEG5variableDeactivate ( MHEG5Ingredient * variable )

Apply the deactivation behaviour of the variable class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.

Parameters

MHEG5Ingredient *variable

Returns: void

void MHEG5variableDestruct ( MHEG5Ingredient * variable )

Destruct a variable object.

Parameters

MHEG5Ingredient *variable

Returns: void

void MHEG5variablePrepare ( MHEG5Ingredient * variable )

Apply the preparation behaviour of the variable class Apply the preparation behaviour of the variable class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.

Parameters

MHEG5Ingredient *variable

Returns: void

MHEG5Int MHEG5variableRead	(	MHEG5Ingredient *	v,
		char *	buf,
		MHEG5Int	max_size
	)

This functions reads the value of a variable from the persistant storage. Implementation of the ReadPersistant (...) action of the variable class.

Returns: *; MHEG5ErrorCode

MHEG5Int MHEG5variableStore	(	MHEG5Ingredient *	v,
		void *	buf,
		MHEG5Int	bufLen
	)

This functions stores the value of a variable in the persistant storage. Implementation of the StorePersistant (...) action of the variable class.

Returns: *; MHEG5ErrorCode

Data Structures

Functions

Detailed Description

Function Documentation