A.3 Solution Set definitions
28.6263GPPRelease 17Solution Set (SS) definitionsState management data definition Integration Reference Point (IRP)Telecommunication managementTS
A.3.1 IDL definition structure
Clause A.3.2 contains const definitions for State Management Data Definition IRP.
Clause A.3.3 contains commonly used optional definitions for State Management Data Definition IRP.
Clause A.3.4 contains commonly used definitions for State Management Data Definition IRP.
A.3.2 IDL specification “StateManagementIRPConstDefs.idl”
//File:- StateManagementIRPConstDefs.idl
#ifndef _STATE_MANAGEMENT_IRP_CONST_DEFS_IDL_
#define _STATE_MANAGEMENT_IRP_CONST_DEFS_IDL_
#include "CosNotification.idl"
#include "ManagedGenericIRPConstDefs.idl"
#include <StateManagementIRPCommonConstDefs.idl>
#include <StateManagementIRPOptConstDefs.idl>
// This statement must appear after all include statements
#pragma prefix "3gppsa5.org"
/* ## Module: StateManagementIRPConstDefs
This module contains commonly used definitions for State Management IRP
========================================================================
*/
module StateManagementIRPConstDefs
{
/*
Constant definitions for state management notifications uses when populating the
Cos::Structured event.
The "name" party of the structured event carries the following constant definitions
appropriate to the state being notified.
Refer to TS 32.666 regarding how to populate the structured event
*/
interface AttributeNameValue {
const string OPERATIONAL_STATE = "operationalState";
const string USAGE_STATE = "usageState";
const string ADMINISTRATIVE_STATE = "administrativeState";
const string ALARM_STATUS = "alarmStatus";
const string PROCEDURAL_STATUS = "proceduralStatus";
const string AVAILABILITY_STATUS = "availabilityStatus";
const string CONTROL_STATUS = "controlStatus";
const string STANDBY_STATUS = "standbyStatus";
const string UNKNOWN_STATUS = "unknownStatus";
};
/*
The following structures provide the new state value,
and the optional old state value
The structures are passed in the value part of the cos structured event
*/
struct OperationalStateOldNewValue{
StateManagementIRPCommonConstDefs::OperationalState new;
StateManagementIRPOptConstDefs::OperationalStateTypeOpt old;
};
struct UsageStateOldNewValue{
StateManagementIRPCommonConstDefs::UsageState new;
StateManagementIRPOptConstDefs::UsageStateTypeOpt old;
};
struct AdministrativeStateOldNewValue{
StateManagementIRPCommonConstDefs::AdministrativeState new;
StateManagementIRPOptConstDefs::AdministrativeStateTypeOpt old;
};
struct AlarmStatusOldNewValue{
StateManagementIRPCommonConstDefs::AlarmStatus new;
StateManagementIRPOptConstDefs::AlarmStatusTypeOpt old;
};
struct ProceduralStatusOldNewValue{
StateManagementIRPCommonConstDefs::ProceduralStatusValues new;
StateManagementIRPOptConstDefs::ProceduralStatusTypeOpt old;
};
struct AvailabilityStatusOldNewValue{
StateManagementIRPCommonConstDefs::AvailabilityStatusValues new;
StateManagementIRPOptConstDefs:: AvailabilityStatusTypeOpt old;
};
struct ControlStatusOldNewValue{
StateManagementIRPCommonConstDefs::ControlStatusValues new;
StateManagementIRPOptConstDefs::ControlStatusTypeOpt old;
};
struct StandbyStatusOldNewValue{
StateManagementIRPCommonConstDefs::StandbyStatus new;
StateManagementIRPOptConstDefs::StandbyStatusTypeOpt old;
};
struct UnknownStatusOldNewValue{
StateManagementIRPCommonConstDefs::UnknownStatus new;
StateManagementIRPOptConstDefs::UnknownStatusTypeOpt old;
};
};
#endif // _STATE_MANAGEMENT_IRP_CONST_DEFS_IDL_
A.3.3 IDL specification “StateManagementIRPOptConstDefs.idl”
//File:-StateManagementIRPOptConstDefs.idl
#ifndef _STATE_MANAGEMENT_IRP_OPT_CONST_DEFS_IDL_
#define _STATE_MANAGEMENT_IRP_OPT_CONST_DEFS_IDL_
#include "CosNotification.idl"
#include "ManagedGenericIRPConstDefs.idl"
#include "StateManagementIRPCommonConstDefs.idl"
// This statement must appear after all include statements
#pragma prefix "3gppsa5.org"
/* ## Module: StateManagementIRPOptConstDefs
This module contains commonly used optional definitions for State Management IRP
================================================================================
*/
module StateManagementIRPOptConstDefs
{
/*
Definition of Operational State based on X.721 [3], if optional.
*/
union OperationalStateTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::OperationalState operational_state;
};
/*
Definition of Usage State based on X.721 [3], if optional.
*/
union UsageStateTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::UsageState usage_state;
};
/*
Definition of Administrative State based on X.721 [3], if optional.
*/
union AdministrativeStateTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::AdministrativeState administrative_state;
};
/*
Definition of Alarm Status based on M.3100 [4], if optional.
*/
union AlarmStatusTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::AlarmStatus alarm_status;
};
/*
Definition of Procedural Status based on X.721 [3], if optional.
*/
union ProceduralStatusTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::ProceduralStatus procedural_status;
};
/*
Definition of Availability Status based on X.721 [3], if optional.
*/
union AvailabilityStatusTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::AvailabilityStatus availability_status;
};
/*
Definition of Control Status based on X.721 [3], if optional.
*/
union ControlStatusTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::ControlStatus control_status;
};
/*
Definition of Standby Status based on X.721 [3], if optional.
*/
union StandbyStatusTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::StandbyStatus standby_status;
};
/*
Definition of Unknown Status based on X.721 [3], if optional.
*/
union UnknownStatusTypeOpt switch(boolean)
{
case TRUE: StateManagementIRPCommonConstDefs::UnknownStatus unknown_status;
};
};
#endif // _STATE_MANAGEMENT_IRP_OPT_CONST_DEFS_IDL_
A.3.4 IDL specification “StateManagementIRPCommonConstDefs.idl”
//File: StateManagementIRPCommonConstDefs.idl
#ifndef _State_Management_IRP_COMMON_Const_Defs_idl_
#define _State_Management_IRP_COMMON_Const_Defs_idl_
// This statement must appear after all include statements
#pragma prefix "3gppsa5.org"
/* Module: StateManagementIRPCommonConstDefs
This module contains commonly used definitions for State Management IRP
========================================================================
*/
module StateManagementIRPCommonConstDefs
{
/*
Definition of Operational State based on X.721 [3], if mandatory.
*/
enum OperationalState
{
Disabled, Enabled
};
/*
Definition of Usage State based on X.721 [3], if mandatory.
*/
enum UsageState
{
Idle, Active, Busy
};
/*
Definition of Administrative State based on X.721 [3], if mandatory.
*/
enum AdministrativeState
{
Locked, Unlocked, ShuttingDown
};
/*
Definition of Alarm Status based on M.3100 [4], if mandatory.
*/
enum AlarmStatus
{
CLEARED, INDETERMINATE, WARNING, MINOR, MAJOR, CRITICAL
};
/*
Definition of Procedural Status based on X.721 [3], if mandatory.
*/
enum ProceduralStatusValues
{
InitializationRequired, NotInitialized, Initializing, Reporting,
Terminating
};
typedef sequence <ProceduralStatusValues,5> ProceduralStatus;
/*
Definition of Availability Status based on X.721 [3], if mandatory.
*/
enum AvailabilityStatusValues
{
InTest, Failed, PowerOff, OffLine, OffDuty, Dependency, Degraded,
NotInstalled, LogFull
};
typedef sequence <AvailabilityStatusValues,9> AvailabilityStatus;
/*
Definition of Control Status based on X.721 [3], if mandatory.
*/
enum ControlStatusValues
{
SubjectToTest, PartOfServicesLocked, ReservedForTest, Suspended
};
typedef sequence <ControlStatusValues,4> ControlStatus;
/*
Definition of Standby Status based on X.721 [3], if mandatory.
*/
enum StandbyStatus
{
HotStandby, ColdStandby, ProvidingService
};
/*
Definition of Unknown Status based on X.721 [3], if mandatory
(if switch is TRUE then value equal to TRUE implies "unknown status").
*/
union UnknownStatus switch(boolean)
{
case TRUE: boolean value;
};
};
#endif //_STATE_MANAGEMENT_IRP_COMMON_CONST_DEFS_IDL_
Annex B (normative):
XML definitions