VR-Exchange 2.1 API Documentation
pDataQueryInter.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2012 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 /* VR-Exchange header files */
13 #include <portal/pBaseInteraction.h> //class DtPortalBaseInteraction
14 
15 namespace MAKVrExchange
16 {
17 
18  class DtPortalConnection;
19 
23  class DT_DLL_LIBPORTAL DtPortalDataQueryInteraction : public DtPortalBaseInteraction
24  {
25  public:
26 
29  typedef void (*functionCallback_type) (
30  const DtPortalDataQueryInteraction &interaction, void *userDataQuery);
31 
33  DtPortalDataQueryInteraction();
34 
36  virtual ~DtPortalDataQueryInteraction();
37 
43 
46 
47  DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
48  DtDEC_ATTRIBUTE( DtString, ReceivingEntity, receivingEntity );
49  DtDEC_ATTRIBUTE( DtU32, RequestIdentifier, requestIdentifier );
50  DtDEC_ATTRIBUTE( DtTime, TimeInterval, timeInterval );
51  DtDEC_ATTRIBUTE( std::vector<DtU32>, FixedDatums, fixedDatums );
52  DtDEC_ATTRIBUTE( std::vector<DtU32>, VariableDatums, variableDatums );
54 
56  public:
57 
61  static const DtPortalMessageKind theKind;
62 
63  //Doxygen comments inherited from parent class
64  virtual DtPortalMessageKind kind() const;
65 
66  //Doxygen comments inherited from parent class
67  virtual const char* interactionKindName() const;
68 
69  //Doxygen comments inherited from parent class
70  virtual unsigned int netSize() const;
71 
72  //Doxygen comments inherited from parent class
73  virtual void writeSelfToBuffer( void* buffer ) const;
74 
75  //Doxygen comments inherited from parent class
76  virtual void readSelfFromBuffer( const void* buffer );
77 
86  static void addCallback( DtPortalConnection* connection,
87  functionCallback_type callbackFunction,
88  void* userDataQuery );
89 
98  static void removeCallback( DtPortalConnection* connection,
99  functionCallback_type callbackFunction,
100  void* userDataQuery );
101 
109  static DtPortalMessage* create();
110 
111  //Doxygen comments inherited from parent class
112  virtual std::ostream &printDataQueryToStream( std::ostream& stream ) const;
113 
114  private:
115 
117  DtPortalDataQueryInteraction &operator=( const DtPortalDataQueryInteraction& );
118 
120  bool operator==( const DtPortalDataQueryInteraction& ) const;
121 
123  bool operator!=( const DtPortalDataQueryInteraction& ) const;
124 
125  }; //end class DtPortalDataQueryInteraction
126 
127 
128  inline DtPortalMessage* DtPortalDataQueryInteraction::create()
129  {
130  return new DtPortalDataQueryInteraction();
131  }
132 
133  inline const char* DtPortalDataQueryInteraction::interactionKindName() const
134  {
135  return "DataQuery";
136  }
137 
138  inline DtPortalMessageKind DtPortalDataQueryInteraction::kind() const
139  {
140  return theKind;
141  }
142 
143 }
Document ID: Generated on Tue Aug 7 22:07:13 EDT 2012 from SVN revision 117874
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)