megaco_test_msg_v1_lib.erl

OTP是开放电信平台的简称

%% ``The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved via the world wide web at http://www.erlang.org/.
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and limitations
%% under the License.
%%
%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
%% AB. All Rights Reserved.''
%%
%%     $Id$
%%
%%----------------------------------------------------------------------
%% Purpose: Utility functions for creating the megaco types
%%          This file is originally a copy of megaco_test_msg_v2_lib.erl
%%          which is why so much of it is commented out.
%%----------------------------------------------------------------------

-module(megaco_test_msg_v1_lib).

%% ----

-include_lib("megaco/include/megaco_message_v1.hrl").
-include_lib("megaco/include/megaco.hrl").

%% ----

-export([
 	 cre_MegacoMessage/1, cre_MegacoMessage/2, 
%% 	 cre_AuthenticationHeader/3,
 	 cre_Message/3,
%% 	 cre_ErrorDescriptor/1, cre_ErrorDescriptor/2, 
%% 	 cre_ErrorCode/1, 
%% 	 cre_ErrorText/1, 
 	 cre_ContextID/1, 
 	 cre_Transaction/1, 
 	 cre_TransactionId/1, 
 	 cre_TransactionRequest/2, 
%% 	 cre_TransactionPending/1, 
%% 	 cre_TransactionReply/2, cre_TransactionReply/3, 
%% 	 cre_TransactionAck/1, cre_TransactionAck/2, 
 	 cre_ActionRequest/2, cre_ActionRequest/3, cre_ActionRequest/4, 
%% 	 cre_ActionReply/2, cre_ActionReply/3, cre_ActionReply/4, 
%% 	 cre_ContextRequest/0, cre_ContextRequest/1, cre_ContextRequest/2, 
%% 	 cre_ContextRequest/3, 
%% 	 cre_ContextAttrAuditRequest/0, cre_ContextAttrAuditRequest/3, 
%% 	 cre_CommandRequest/1, cre_CommandRequest/2, cre_CommandRequest/3, 
%% 	 cre_Command/2, 
%% 	 cre_CommandReply/2, 
%% 	 cre_TopologyRequest/3, cre_TopologyRequest/4, 
%% 	 cre_AmmRequest/2, 
 	 cre_AmmDescriptor/1, 
%% 	 cre_AmmsReply/1, cre_AmmsReply/2, 
%% 	 cre_SubtractRequest/1, cre_SubtractRequest/2, 
%% 	 cre_AuditRequest/2, 
%% 	 cre_AuditReply/1, 
%% 	 cre_AuditResult/2, 
%% 	 cre_AuditReturnParameter/1, 
%% 	 cre_AuditDescriptor/0, cre_AuditDescriptor/1, cre_AuditDescriptor/2, 
%% 	 cre_IndAuditParameter/1, 
%% 	 cre_IndAudMediaDescriptor/0, cre_IndAudMediaDescriptor/1, 
%% 	 cre_IndAudMediaDescriptor/2, 
%% 	 cre_IndAudStreamDescriptor/2, 
%% 	 cre_IndAudStreamParms/0, cre_IndAudStreamParms/1, 
%% 	 cre_IndAudStreamParms/3, 
%% 	 cre_IndAudLocalControlDescriptor/0, 
%% 	 cre_IndAudLocalControlDescriptor/4, 
%% 	 cre_IndAudPropertyParm/1, 
%% 	 cre_IndAudLocalRemoteDescriptor/1, 
%% 	 cre_IndAudLocalRemoteDescriptor/2, 
%% 	 cre_IndAudPropertyGroup/1, 
%% 	 cre_IndAudTerminationStateDescriptor/1, 
%% 	 cre_IndAudTerminationStateDescriptor/3, 
%% 	 cre_IndAudEventsDescriptor/1, cre_IndAudEventsDescriptor/2, 
%% 	 cre_IndAudEventsDescriptor/3, 
%% 	 cre_IndAudEventBufferDescriptor/1, 
%% 	 cre_IndAudEventBufferDescriptor/2, 
%% 	 cre_IndAudSignalsDescriptor/1, 
%% 	 cre_IndAudSeqSigList/1, 
%% 	 cre_IndAudSeqSigList/2, 
%% 	 cre_IndAudSignal/1, cre_IndAudSignal/2, 
%% 	 cre_IndAudDigitMapDescriptor/0, cre_IndAudDigitMapDescriptor/1, 
%% 	 cre_IndAudStatisticsDescriptor/1, 
%% 	 cre_IndAudPackagesDescriptor/2, 
%% 	 cre_NotifyRequest/2, cre_NotifyRequest/3, 
%% 	 cre_NotifyReply/1, cre_NotifyReply/2, 
%% 	 cre_ObservedEventsDescriptor/2, 
%% 	 cre_ObservedEvent/2, cre_ObservedEvent/3, cre_ObservedEvent/4, 
 	 cre_EventName/1, 
 	 cre_EventParameter/2, cre_EventParameter/4, 
%% 	 cre_ServiceChangeRequest/2, 
%% 	 cre_ServiceChangeReply/2, 
%% 	 cre_ServiceChangeResult/1, 
%% 	 %% cre_WildcardField/1, 
%% 	 cre_TerminationID/2, 
%% 	 cre_TerminationIDList/1, 
%% 	 cre_MediaDescriptor/0, cre_MediaDescriptor/1, cre_MediaDescriptor/2, 
%% 	 cre_StreamDescriptor/2, 
%% 	 cre_StreamParms/0, cre_StreamParms/1, cre_StreamParms/2, 
%% 	 cre_StreamParms/3, 
%% 	 cre_LocalControlDescriptor/1, cre_LocalControlDescriptor/2, 
%% 	 cre_LocalControlDescriptor/4, 
%% 	 cre_StreamMode/1, 
%% 	 cre_PropertyParm/2, cre_PropertyParm/4, 
%% 	 cre_Name/1, 
 	 cre_PkgdName/1, 
 	 cre_PkgdName/2, 
%% 	 cre_Relation/1, 
%% 	 cre_LocalRemoteDescriptor/1, 
%% 	 cre_PropertyGroup/1, 
%% 	 cre_TerminationStateDescriptor/1, 
%% 	 cre_TerminationStateDescriptor/2, 
%% 	 cre_TerminationStateDescriptor/3, 
%% 	 cre_EventBufferControl/1, 
%% 	 cre_ServiceState/1, 
%% 	 cre_MuxDescriptor/2, %% cre_MuxDescriptor/3, 
%% 	 cre_MuxType/1, 
%% 	 cre_StreamID/1, 
%% 	 cre_EventsDescriptor/0, cre_EventsDescriptor/2, 
%% 	 cre_RequestedEvent/1, 
%% 	 cre_RequestedEvent/2, cre_RequestedEvent/3, cre_RequestedEvent/4, 
%% 	 cre_RequestedActions/0, 
%% 	 cre_RequestedActions/1, cre_RequestedActions/4, 
%% 	 cre_EventDM/1, 
%% 	 cre_SecondEventsDescriptor/1, cre_SecondEventsDescriptor/2, 
%% 	 cre_SecondRequestedEvent/2, cre_SecondRequestedEvent/3, 
%% 	 cre_SecondRequestedEvent/4, 
%% 	 cre_SecondRequestedActions/0, cre_SecondRequestedActions/1, 
%% 	 cre_SecondRequestedActions/2, cre_SecondRequestedActions/3, 
 	 cre_EventBufferDescriptor/1, 
 	 cre_EventSpec/2, 
 	 cre_EventSpec/3, 
%% 	 cre_SignalsDescriptor/1, 
%% 	 cre_SignalRequest/1, 
%% 	 cre_SeqSigList/2, 
%% 	 cre_Signal/1, cre_Signal/2, cre_Signal/7, 
%% 	 cre_SignalType/1, 
%% 	 cre_SignalName/1, 
%% 	 cre_NotifyCompletion/1, 
%% 	 cre_SigParameter/2, cre_SigParameter/4, 
%% 	 cre_RequestID/1, 
%% 	 cre_ModemDescriptor/2, %% cre_ModemDescriptor/3, 
%% 	 cre_ModemType/1, 
%% 	 cre_DigitMapDescriptor/0, cre_DigitMapDescriptor/1, 
%% 	 cre_DigitMapDescriptor/2, 
%% 	 cre_DigitMapName/1, 
%% 	 cre_DigitMapValue/1, cre_DigitMapValue/4, cre_DigitMapValue/5, 
%% 	 cre_ServiceChangeParm/2, cre_ServiceChangeParm/4, 
%% 	 cre_ServiceChangeParm/9, 
%% 	 cre_ServiceChangeAddress/2, 
%% 	 cre_ServiceChangeResParm/0, cre_ServiceChangeResParm/2, 
%% 	 cre_ServiceChangeResParm/5, 
%% 	 cre_ServiceChangeMethod/1, 
%% 	 cre_ServiceChangeProfile/1, cre_ServiceChangeProfile/2, 
%% 	 cre_PackagesDescriptor/1, 
%% 	 cre_PackagesItem/2, 
%% 	 cre_StatisticsDescriptor/1, 
%% 	 cre_StatisticsParameter/1, cre_StatisticsParameter/2, 
%% %% 	 cre_NonStandardData/2, 
%% %% 	 cre_NonStandardIdentifier/1, 
%% %% 	 cre_H221NonStandard/4, 
%% 	 cre_TimeNotation/2, 
%% 	 cre_Value/1, 
 	 cre_BOOLEAN/1
	]).  


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

cre_MegacoMessage(M) when record(M, 'Message') ->
    #'MegacoMessage'{mess = M}.

cre_MegacoMessage(AH, M) 
  when record(AH, 'AuthenticationHeader'), 
       record(M, 'Message') ->
    #'MegacoMessage'{authHeader = AH,
		     mess       = M}.

%% cre_AuthenticationHeader(SPI, SN, AD) ->
%%     #'AuthenticationHeader'{secParmIndex = SPI, 
%% 			    seqNum       = SN, 
%% 			    ad           = AD}.

cre_Message(V, Mid, ED) when is_record(ED, 'ErrorDescriptor') ->
    Body = {errorDescriptor, ED},
    #'Message'{version     = V,
	       mId         = Mid,
	       messageBody = Body};
cre_Message(V, Mid, Transactions) when is_list(Transactions) ->
    Body = {transactions, Transactions},
    #'Message'{version     = V,
	       mId         = Mid,
	       messageBody = Body};
cre_Message(V, Mid, {transactions, T} = Body) when is_list(T) ->
    #'Message'{version     = V,
	       mId         = Mid,
	       messageBody = Body};
cre_Message(V, Mid, {errorDescriptor, ED} = Body) 
  when is_record(ED, 'ErrorDescriptor') ->
    #'Message'{version     = V,
	       mId         = Mid,
	       messageBody = Body}.


%% cre_ErrorDescriptor(EC) when integer(EC) ->
%%     #'ErrorDescriptor'{errorCode = EC}.

%% cre_ErrorDescriptor(EC, ET) when integer(EC), list(ET) ->
%%     #'ErrorDescriptor'{errorCode = EC, errorText = ET}.

%% cre_ErrorCode(C) when integer(C), 0 =< C, C =< 65535 ->
%%     C;
%% cre_ErrorCode(C) ->
%%     exit({invalid_ErrorCode, C}).

%% cre_ErrorText(T) when list(T) ->
%%     T.

cre_ContextID(Val) when (0 =< Val) and (Val =< 4294967295) ->
    Val;
cre_ContextID(Val) ->
    exit({invalid_ContextID, Val}).

cre_Transaction(TR) when record(TR, 'TransactionRequest') ->
    {transactionRequest, TR};
cre_Transaction(TP) when record(TP, 'TransactionPending') ->
    {transactionPending, TP};
cre_Transaction(TR) when record(TR, 'TransactionReply') ->
    {transactionReply, TR};
cre_Transaction(TRA) when list(TRA) ->
    {transactionResponseAck, TRA}.

cre_TransactionId(Val) when 0 =< Val, Val =< 4294967295 ->
    Val;
cre_TransactionId(Val) ->
    exit({invalid_TransactionId, Val}).

cre_TransactionRequest(TransID, ARs) when integer(TransID), list(ARs) -> 
    #'TransactionRequest'{transactionId = TransID, 
			  actions       = ARs}.

%% cre_TransactionPending(TransID) when integer(TransID) ->
%%     #'TransactionPending'{transactionId = TransID}.

%% cre_TransactionReply(TransID, ED) 
%%   when integer(TransID), record(ED, 'ErrorDescriptor') ->
%%     Res = {transactionError, ED},
%%     #'TransactionReply'{transactionId     = TransID,
%% 			transactionResult = Res};
%% cre_TransactionReply(TransID, ARs) 
%%   when integer(TransID), list(ARs) ->
%%     Res = {actionReplies, ARs},
%%     #'TransactionReply'{transactionId     = TransID,
%% 			transactionResult = Res}.

%% cre_TransactionReply(TransID, IAR, ED) 
%%   when is_integer(TransID) and 
%%        ((IAR == 'NULL') or (IAR == asn1_NOVALUE)) and 
%%        is_record(ED, 'ErrorDescriptor') ->
%%     Res = {transactionError, ED},
%%     #'TransactionReply'{transactionId     = TransID,
%% 			transactionResult = Res};
%% cre_TransactionReply(TransID, IAR, ARs) 
%%   when is_integer(TransID) and 
%%        ((IAR == 'NULL') or (IAR == asn1_NOVALUE)) and 
%%        is_list(ARs) ->
%%     Res = {actionReplies, ARs},
%%     #'TransactionReply'{transactionId     = TransID,
%% 			transactionResult = Res}.

%% cre_TransactionAck(FirstAck) ->
%%     #'TransactionAck'{firstAck = FirstAck}.

%% cre_TransactionAck(FirstAck, FirstAck) ->
%%     #'TransactionAck'{firstAck = FirstAck};
%% cre_TransactionAck(FirstAck, LastAck) ->
%%     #'TransactionAck'{firstAck = FirstAck, 
%% 		      lastAck  = LastAck}.

cre_ActionRequest(CtxID, CmdReqs) 
  when is_integer(CtxID) and is_list(CmdReqs) ->
    #'ActionRequest'{contextId       = CtxID,
		     commandRequests = CmdReqs}.

cre_ActionRequest(CtxID, CtxReq, CmdReqs) 
  when is_integer(CtxID) and 
       is_record(CtxReq, 'ContextRequest') and
       is_list(CmdReqs) ->
    #'ActionRequest'{contextId       = CtxID,
		     contextRequest  = CtxReq,
		     commandRequests = CmdReqs};
cre_ActionRequest(CtxID, CAAR, CmdReqs) 
  when is_integer(CtxID) and 
       is_record(CAAR, 'ContextAttrAuditRequest') and 
       is_list(CmdReqs) ->
    #'ActionRequest'{contextId           = CtxID,
		     contextAttrAuditReq = CAAR,
		     commandRequests     = CmdReqs}.

cre_ActionRequest(CtxID, CtxReq, CAAR, CmdReqs) 
  when is_integer(CtxID) and 
       is_record(CtxReq, 'ContextRequest') and 
       is_record(CAAR, 'ContextAttrAuditRequest') and 
       is_list(CmdReqs) ->
    #'ActionRequest'{contextId           = CtxID,
		     contextRequest      = CtxReq,
		     contextAttrAuditReq = CAAR,
		     commandRequests     = CmdReqs}.

%% cre_ActionReply(CtxID, CmdReps) 
%%   when integer(CtxID), 
%%        list(CmdReps) ->
%%     #'ActionReply'{contextId    = CtxID,
%% 		   commandReply = CmdReps}.

%% cre_ActionReply(CtxID, ED, CmdReps) 
%%   when integer(CtxID), 
%%        record(ED, 'ErrorDescriptor'), 
%%        list(CmdReps) ->
%%     #'ActionReply'{contextId       = CtxID,
%% 		   errorDescriptor = ED, 
%% 		   commandReply    = CmdReps};
%% cre_ActionReply(CtxID, CtxReq, CmdReps) 
%%   when integer(CtxID), 
%%        record(CtxReq, 'ContextRequest'), 
%%        list(CmdReps) ->
%%     #'ActionReply'{contextId    = CtxID,
%% 		   contextReply = CtxReq, 
%% 		   commandReply = CmdReps}.

%% cre_ActionReply(CtxID, ED, CtxReq, CmdReps) 
%%   when integer(CtxID), 
%%        record(ED, 'ErrorDescriptor'), 
%%        record(CtxReq, 'ContextRequest'), 
%%        list(CmdReps) ->
%%     #'ActionReply'{contextId       = CtxID,
%% 		   errorDescriptor = ED, 
%% 		   contextReply    = CtxReq, 
%% 		   commandReply    = CmdReps}.

%% cre_ContextRequest() ->
%%     #'ContextRequest'{}.

%% cre_ContextRequest(Prio) when integer(Prio), 0 =< Prio, Prio =< 15 ->
%%     #'ContextRequest'{priority = Prio};
%% cre_ContextRequest(Em) when Em == true; Em == false; Em == asn1_NOVALUE ->
%%     #'ContextRequest'{emergency = Em};
%% cre_ContextRequest(Top) when list(Top) ->
%%     #'ContextRequest'{topologyReq = Top}.

%% cre_ContextRequest(Prio, Em) 
%%   when (is_integer(Prio) and (0 =< Prio) and (Prio =< 15)) and 
%%        ((Em == true) or (Em == false) or (Em == asn1_NOVALUE)) ->
%%     #'ContextRequest'{priority  = Prio,
%% 		      emergency = Em};
%% cre_ContextRequest(Prio, Top) 
%%   when integer(Prio), 0 =< Prio, Prio =< 15, list(Top) ->
%%     #'ContextRequest'{priority    = Prio,
%% 		      topologyReq = Top}.

%% cre_ContextRequest(Prio, Em, Top) 
%%   when (is_integer(Prio) and (0 =< Prio) and (Prio =< 15)) and 
%%        ((Em == true) or (Em == false) or (Em == asn1_NOVALUE)) and
%%        is_list(Top) ->
%%     #'ContextRequest'{priority    = Prio,
%% 		      emergency   = Em,
%% 		      topologyReq = Top}.