MAK RTIspy API Documentation for HLA 1516: repSerInv.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2001 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: repSerInv.h,v $ $Revision: 1.9 $ $State: Exp $
00007 *********************************************************************/
00010 
00011 #ifndef DtReportServiceInvocationInteraction_H_
00012 #define DtReportServiceInvocationInteraction_H_
00013 #ifdef DtMOM
00014 #ifdef DtIFSPEC13
00015 
00016 #include "rtiMsConfig.h"
00017 #include "internalTypes.h"
00018 #include "mInteraction.h"
00019 #include <vlutil/vlList.h>
00020 
00021 class DtMomInterCbMgr;
00022 class DtReportServiceInvocationInteraction;
00023 typedef void (*DtReportServiceInvocationInteractionCb)
00024    (const DtReportServiceInvocationInteraction& inter, void* usr);
00025 
00026 class DT_DLL_LRC DtReportServiceInvocationInteraction :
00027    public DtReportInteraction
00028 {
00029 public:
00030 
00032    DtReportServiceInvocationInteraction();
00033 
00035    virtual ~DtReportServiceInvocationInteraction();
00036 
00038    DtReportServiceInvocationInteraction(
00039       const DtReportServiceInvocationInteraction& orig);
00040  
00042    DtReportServiceInvocationInteraction& operator=(
00043       const DtReportServiceInvocationInteraction& orig);
00044 
00047    virtual const DtPhvps& phvps();
00048 
00051    virtual bool setFromPhvps(const DtPhvps& phvps);
00052 
00054    virtual MAKRti::DtString const & service() const;
00055    virtual void setService(MAKRti::DtString const & data);
00056    
00058    virtual DtMomInitiatorOptions initiator() const;
00059    virtual void setInitiator(DtMomInitiatorOptions data);
00060    
00062    virtual bool successIndicator() const;
00063    virtual void setSuccessIndicator(bool data);
00064    
00066    virtual MAKRti::DtString const & suppliedArgument1() const;
00067    virtual void setSuppliedArgument1(MAKRti::DtString const & data);
00068    
00070    virtual MAKRti::DtString const & suppliedArgument2() const;
00071    virtual void setSuppliedArgument2(MAKRti::DtString const & data);
00072    
00074    virtual MAKRti::DtString const & suppliedArgument3() const;
00075    virtual void setSuppliedArgument3(MAKRti::DtString const & data);
00076    
00078    virtual MAKRti::DtString const & suppliedArgument4() const;
00079    virtual void setSuppliedArgument4(MAKRti::DtString const & data);
00080    
00082    virtual MAKRti::DtString const & suppliedArgument5() const;
00083    virtual void setSuppliedArgument5(MAKRti::DtString const & data);
00084    
00086    virtual MAKRti::DtString const & returnedArgument() const;
00087    virtual void setReturnedArgument(MAKRti::DtString const & data);
00088    
00091    virtual MAKRti::DtString const & exceptionDescription() const;
00092    virtual void setExceptionDescription(MAKRti::DtString const & data);
00093    
00096    virtual long exceptionID() const;
00097    virtual void setExceptionID(long data);
00098    
00099      
00100 public:
00102    static DtReportInteraction* create();
00103 
00105    static void addCallback(DtMomInterCbMgr* callBackManager,
00106       DtReportServiceInvocationInteractionCb cb, void* usr);
00107    static void removeCallback(DtMomInterCbMgr* callBackManager,
00108       DtReportServiceInvocationInteractionCb cb, void* usr);
00109 
00110 protected:
00111 
00113    virtual void encodeService(
00114       const DtMomInteraction& data,
00115       DtPhvps* parameters,
00116       DtParameterHandle parameterHandle);
00117    
00119    virtual void encodeInitiator(
00120       const DtMomInteraction& data,
00121       DtPhvps* parameters,
00122       DtParameterHandle parameterHandle);
00123    
00126    virtual void encodeSuccessIndicator(
00127       const DtMomInteraction& data,
00128       DtPhvps* parameters,
00129       DtParameterHandle parameterHandle);
00130    
00132    virtual void encodeSuppliedArgument1(
00133       const DtMomInteraction& data,
00134       DtPhvps* parameters,
00135       DtParameterHandle parameterHandle);
00136    
00138    virtual void encodeSuppliedArgument2(
00139       const DtMomInteraction& data,
00140       DtPhvps* parameters,
00141       DtParameterHandle parameterHandle);
00142    
00144    virtual void encodeSuppliedArgument3(
00145       const DtMomInteraction& data,
00146       DtPhvps* parameters,
00147       DtParameterHandle parameterHandle);
00148    
00150    virtual void encodeSuppliedArgument4(
00151       const DtMomInteraction& data,
00152       DtPhvps* parameters,
00153       DtParameterHandle parameterHandle);
00154    
00156    virtual void encodeSuppliedArgument5(
00157       const DtMomInteraction& data,
00158       DtPhvps* parameters,
00159       DtParameterHandle parameterHandle);
00160    
00162    virtual void encodeReturnedArgument(
00163       const DtMomInteraction& data,
00164       DtPhvps* parameters,
00165       DtParameterHandle parameterHandle);
00166    
00169    virtual void encodeExceptionDescription(
00170       const DtMomInteraction& data,
00171       DtPhvps* parameters,
00172       DtParameterHandle parameterHandle);
00173    
00176    virtual void encodeExceptionID(
00177       const DtMomInteraction& data,
00178       DtPhvps* parameters,
00179       DtParameterHandle parameterHandle);
00180    
00182    virtual void decodeService(
00183       DtMomInteraction* data,
00184       const DtPhvps& parameters,
00185       int index);
00186    
00188    virtual void decodeInitiator(
00189       DtMomInteraction* data,
00190       const DtPhvps& parameters,
00191       int index);
00192    
00194    virtual void decodeSuccessIndicator(
00195       DtMomInteraction* data,
00196       const DtPhvps& parameters,
00197       int index);
00198    
00200    virtual void decodeSuppliedArgument1(
00201       DtMomInteraction* data,
00202       const DtPhvps& parameters,
00203       int index);
00204    
00206    virtual void decodeSuppliedArgument2(
00207       DtMomInteraction* data,
00208       const DtPhvps& parameters,
00209       int index);
00210    
00212    virtual void decodeSuppliedArgument3(
00213       DtMomInteraction* data,
00214       const DtPhvps& parameters,
00215       int index);
00216    
00218    virtual void decodeSuppliedArgument4(
00219       DtMomInteraction* data,
00220       const DtPhvps& parameters,
00221       int index);
00222    
00224    virtual void decodeSuppliedArgument5(
00225       DtMomInteraction* data,
00226       const DtPhvps& parameters,
00227       int index);
00228    
00230    virtual void decodeReturnedArgument(
00231       DtMomInteraction* data,
00232       const DtPhvps& parameters,
00233       int index);
00234    
00237    virtual void decodeExceptionDescription(
00238       DtMomInteraction* data,
00239       const DtPhvps& parameters,
00240       int index);
00241    
00244    virtual void decodeExceptionID(
00245       DtMomInteraction* data,
00246       const DtPhvps& parameters,
00247       int index);
00248    
00249 public:
00250    static const char* theInteractionName;
00251 
00252 protected:
00254    MAKRti::DtString myService;
00255    DtMomInitiatorOptions myInitiator;
00256    bool mySuccessIndicator;
00257    MAKRti::DtString mySuppliedArgument1;
00258    MAKRti::DtString mySuppliedArgument2;
00259    MAKRti::DtString mySuppliedArgument3;
00260    MAKRti::DtString mySuppliedArgument4;
00261    MAKRti::DtString mySuppliedArgument5;
00262    MAKRti::DtString myReturnedArgument;
00263    MAKRti::DtString myExceptionDescription;
00264    long myExceptionID;
00265 
00266    const char *SERVICE_PARAMETER_NAME;
00267    const char *INITIATOR_PARAMETER_NAME;
00268    const char *SUCCESS_INDICATOR_PARAMETER_NAME;
00269    const char *SUPPLIED_ARGUMENT1_PARAMETER_NAME;
00270    const char *SUPPLIED_ARGUMENT2_PARAMETER_NAME;
00271    const char *SUPPLIED_ARGUMENT3_PARAMETER_NAME;
00272    const char *SUPPLIED_ARGUMENT4_PARAMETER_NAME;
00273    const char *SUPPLIED_ARGUMENT5_PARAMETER_NAME;
00274    const char *RETURNED_ARGUMENT_PARAMETER_NAME;
00275    const char *EXCEPTION_DESCRIPTION_PARAMETER_NAME;
00276    const char *EXCEPTION_ID_PARAMETER_NAME;
00277 
00278 };
00279 
00280 #endif //! DtIFSPEC1516
00281 #endif //! DtMOM
00282 #endif //! DtReportServiceInvocationInteraction_H_