managedgenericirpconstdefs.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

//File: ManagedGenericIRPConstDefs.idl
#ifndef _MANAGED_GENERIC_IRP_CONST_DEFS_IDL_
#define _MANAGED_GENERIC_IRP_CONST_DEFS_IDL_

#include <TimeBase.idl>

// This statement must appear after all include statements
#pragma prefix "3gppsa5.org"

/* ## Module: ManagedGenericIRPConstDefs
This module contains definitions commonly used among all IRPs such as Alarm IRP.
================================================================
*/
module ManagedGenericIRPConstDefs
{
   /*
   Definition imported from CosTime.
   The time refers to time in Greenwich Time Zone.
   It also consists of a time displacement factor in the form of minutes of
   displacement from the Greenwich Meridian.
   */
   typedef TimeBase::UtcT IRPTime;

   enum Signal {OK, FAILURE, PARTIAL_FAILURE};

   /*
   The VersionNumber is a string that identifies the IRP specification name
   and its version number. See definition "IRP document version number
   string" or "IRPVersion".

   The VersionNumberSet is a sequence of such VersionNumber. It is returned
   by get_XXX_IRP_versions(). The sequence order has no significance.
   */
   typedef string VersionNumber;
   typedef sequence <VersionNumber> VersionNumberSet;

   typedef string MethodName;
   typedef string ParameterName;
   typedef sequence <ParameterName> ParameterList;

   /*
   The Method defines the structure to be returned as part of
   get_supported_operations_profile(). The name shall be the actual method
   name (ex. "attach_push", "change_subscription_filter", etc.)
   The parameter_list contains a list of strings. Each string shall be
   the actual parameter name (ex. "manager_reference", "filter", etc.)
   */
   struct Method
   {
      MethodName name;
      ParameterList parameter_list;
   };

   /*
   List of all methods and their associated parameters.
   */
   typedef sequence <Method> MethodList;

   /*
   StringOpt is a type carrying an optional parameter.
   If the boolean is TRUE, then the value is present.
   Otherwise the value is absent.
   */
   union StringOpt switch (boolean)
   {
      case TRUE: string value;
   };

   /*
   ShortOpt is a type carrying an optional parameter.
   If the boolean is TRUE, then the value is present.
   Otherwise the value is absent.
   */
   union ShortOpt switch (boolean)
   {
      case TRUE: short value;
   };

   /*
   UnsignedShortOpt is a type carrying an optional parameter.
   If the boolean is TRUE, then the value is present.
   Otherwise the value is absent.
   */
   union UnsignedShortOpt switch (boolean)
   {
      case TRUE: unsigned short value;
   };

   /*
   LongOpt is a type carrying an optional parameter.
   If the boolean is TRUE, then the value is present.
   Otherwise the value is absent.
   */
   union LongOpt switch (boolean)
   {
      case TRUE: long value;
   };

   /*
   UnsignedLongOpt is a type carrying an optional parameter.
   If the boolean is TRUE, then the value is present.
   Otherwise the value is absent.
   */
   union UnsignedLongOpt switch (boolean)
   {
      case TRUE: unsigned long value;
   };

};

#endif // _MANAGED_GENERIC_IRP_CONST_DEFS_IDL_