WebLVC 1.7d API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
pTransferControlInteraction.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2016 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <portal/pInteraction.h>
14 
15 namespace MAKVrExchange
16 {
17 
18  class DtPortalConnection;
19 
23  : public DtPortalInteraction
24  {
25  public:
26 
28  typedef void (*functionCallback_type) (
29  const DtPortalTransferControlInteraction& interaction, void* usr );
30 
33 
36 
39 
42 
44  static void addCallback( DtPortalConnection* connection,
45  functionCallback_type callbackFunction, void* userData );
46 
48  static void removeCallback( DtPortalConnection* connection,
49  functionCallback_type callbackFunction, void* userData );
50 
53 
54  DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
55  DtDEC_ATTRIBUTE( DtString, ReceivingEntity, receivingEntity );
56  DtDEC_ATTRIBUTE( DtU32, RequestIdentifier, requestIdentifier );
57  DtDEC_ATTRIBUTE( DtU32, TransferType, transferType );
58  DtDEC_ATTRIBUTE( DtString, TransferredEntityID, transferredEntityID );
59 
61  public:
62 
66  virtual DtU32 numRecordSets() const;
67 
70  virtual bool setRecordSet( int index, const DtRecordSet& set );
71  virtual const DtRecordSet& recordSet( int index,
72  bool* valid = NULL ) const;
73 
75  virtual const DtVrxRecordSetList& recordSetList() const;
76 
78 
79  public:
80 
82 
83  static DtPortalMessage* create();
84 
85  virtual unsigned int netSize() const;
86  virtual void writeSelfToBuffer( void* buffer, int bufferSize ) const;
87  virtual void readSelfFromBuffer( const void* buffer, int bufferSize );
88 
89  virtual std::ostream& printDataToStream( std::ostream& str ) const;
90 
91  protected:
92 
94 
95  };
96 
97 
99  {
101  }
102 
103 }
Portal TransferControl Interaction class.
Definition: pTransferControlInteraction.h:22
#define DT_DLL_LIBPORTAL
Definition: include/portal/dllExport.h:20
Instances of DtVrxRecordSetList are lists of RecordSets.
Definition: vrxRecordSetList.h:39
#define DtDEC_ATTRIBUTE(T, N, n)
A Macro to define an attribute; as well as make an accessor and mutator for that attribute.
Definition: addAttribute.h:49
static DtPortalMessage * create()
Definition: pTransferControlInteraction.h:98
The base class for all messages passed through the portal.
Definition: pMessage.h:65
Contains the DtPortalInteraction class declaration.
DtVrxRecordSetList myRecordSetList
Definition: pTransferControlInteraction.h:93
DtPortalInteractions are a special type of DtPortalMessages which are used to transmit simulation dat...
Definition: pInteraction.h:21
Connects a broker to the Portal Data Exchange.
Definition: pConnection.h:49
DtPortalMessageKind
A List of message kinds distributed with the Portal.
Definition: pMessageKinds.h:23
static const DtPortalMessageKind theKind
Definition: pTransferControlInteraction.h:81

Document ID: Generated on Wed Jun 21 15:05:44 EDT 2023 from SVN revision 256253
Copyright © 2005-2023 MAK Technologies. All Rights Reserved (www.mak.com)