![]() |
MHEG5
22.11.0
|
Implementation of the Root class. More...
#include <string.h>
#include "mh5base.h"
#include "mh5queue.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5final.h"
#include "mh5debug.h"
Functions | |
void | MHEG5rootInit (MHEG5Root *root) |
Initialise a Root object with default values. More... | |
void | MHEG5rootFree (MHEG5Root *root) |
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 | MHEG5rootClone (MHEG5Root *destination, MHEG5Root *source) |
Implementation of the root part of the Close action. More... | |
void | MHEG5rootPrepare (MHEG5Root *root) |
Implementation of the Preparation behaviour Preparation This behaviour has the basic semantics of allocating all requested resources in order to handle or to present this object. Apply the following sequence of actions: More... | |
void | MHEG5rootActivate (MHEG5Root *root) |
Implementation of the Activation behaviour Activation This behaviour has the basic semantics of immediately making this object active. Apply the following sequence of actions: More... | |
void | MHEG5rootDeactivate (MHEG5Root *root) |
Implementation of the Deactivation behaviour Deactivation This behaviour has the basic semantics of notifying the MHEG-5 engine to deactivate this object immediately. Apply the following sequence of actions: More... | |
void | MHEG5rootDestruct (MHEG5Root *root) |
Implementation of the Destruction behaviour Destruction This behaviour has the basic semantics of asking the MHEG-5 engine to delete the object. Apply the following sequence of actions: More... | |
MHEG5ErrorCode | MHEG5getAvailabilityStatus (MHEG5Root *target, MHEG5GList *params) |
Implementation of the GetAvailabilityStatus action GetAvailabilityStatus (AvailabilityStatusVar) Set the Variable referenced by AvailabilityStatusVar to the value of the AvailabilityStatus attribute. NOTE - A GetAvailabilityStatus action targeted to an object inexistant in the MHEG-5 engine is not an error; the result is False. Provisions of use: AvailabilityStatusVar shall refer to an active BooleanVariable object. GetAvailabilityStatus –> Target, AvailabilityStatusVar Target –> GenericObjectReference AvailabilityStatusVar –> ObjectReference. More... | |
MHEG5ErrorCode | MHEG5getRunningStatus (MHEG5Root *target, MHEG5GList *params) |
Implementation of the GetRunningStatus action GetRunningStatus (RunningStatusVar) Set the Variable referenced by RunningStatusVar to the value of the RunningStatus attribute. Provisions of use: The Target object shall be available. RunningStatusVar shall refer to an active BooleanVariable object. GetRunningStatus –> Target, RunningStatusVar Target –> GenericObjectReference RunningStatusVar –> ObjectReference. More... | |
Implementation of the Root class.
MHEG5ErrorCode MHEG5getAvailabilityStatus | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the GetAvailabilityStatus action GetAvailabilityStatus (AvailabilityStatusVar) Set the Variable referenced by AvailabilityStatusVar to the value of the AvailabilityStatus attribute. NOTE - A GetAvailabilityStatus action targeted to an object inexistant in the MHEG-5 engine is not an error; the result is False. Provisions of use: AvailabilityStatusVar shall refer to an active BooleanVariable object. GetAvailabilityStatus –> Target, AvailabilityStatusVar Target –> GenericObjectReference AvailabilityStatusVar –> ObjectReference.
target | target object for this action |
params | Action parameters |
MHEG5ErrorCode MHEG5getRunningStatus | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the GetRunningStatus action GetRunningStatus (RunningStatusVar) Set the Variable referenced by RunningStatusVar to the value of the RunningStatus attribute. Provisions of use: The Target object shall be available. RunningStatusVar shall refer to an active BooleanVariable object. GetRunningStatus –> Target, RunningStatusVar Target –> GenericObjectReference RunningStatusVar –> ObjectReference.
target | target object for this action |
params | Action parameters |
void MHEG5rootActivate | ( | MHEG5Root * | root | ) |
Implementation of the Activation behaviour Activation This behaviour has the basic semantics of immediately making this object active. Apply the following sequence of actions:
root | Root object to activate |
Implementation of the root part of the Close action.
destination | Root object to clone to |
source | Root object to clone from |
void MHEG5rootDeactivate | ( | MHEG5Root * | root | ) |
Implementation of the Deactivation behaviour Deactivation This behaviour has the basic semantics of notifying the MHEG-5 engine to deactivate this object immediately. Apply the following sequence of actions:
root | Root object to deactivate |
void MHEG5rootDestruct | ( | MHEG5Root * | root | ) |
Implementation of the Destruction behaviour Destruction This behaviour has the basic semantics of asking the MHEG-5 engine to delete the object. Apply the following sequence of actions:
root | Root object to destruct |
void MHEG5rootFree | ( | MHEG5Root * | root | ) |
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.
root | Pointer to object to free. |
void MHEG5rootInit | ( | MHEG5Root * | root | ) |
Initialise a Root object with default values.
root | Root object to initialise |
void MHEG5rootPrepare | ( | MHEG5Root * | root | ) |
Implementation of the Preparation behaviour Preparation This behaviour has the basic semantics of allocating all requested resources in order to handle or to present this object. Apply the following sequence of actions:
root | Root object to prepare |