VR-Exchange 2.8 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
pVrfTask.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/dllExport.h>
13 #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 DtPortalVrfTaskInteraction& interaction, void* userData );
30 
33 
35  virtual ~DtPortalVrfTaskInteraction();
36 
38  static void addCallback( DtPortalConnection* connection,
39  functionCallback_type callbackFunction, void* userData );
40 
42  static void removeCallback( DtPortalConnection* connection,
43  functionCallback_type callbackFunction, void* userData );
44 
47 
48  DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
49  DtDEC_ATTRIBUTE( DtString, ReceivingEntity, receivingEntity );
50  DtDEC_ATTRIBUTE( DtString, ScriptID, scriptID );
51  DtDEC_ATTRIBUTE( bool, Subtask, subtask);
52  DtDEC_ATTRIBUTE( DtAttributeValuePairList, VariableDatumSet, variableDatumSet );
53 
55 
57  public:
58 
60 
61  static DtPortalMessage* create();
62 
63  virtual unsigned int netSize() const;
64  virtual void writeSelfToBuffer( void* buffer, int bufferSize ) const;
65  virtual void readSelfFromBuffer( const void* buffer, int bufferSize );
66 
67  virtual std::ostream& printDataToStream( std::ostream& stream ) const;
68 
69  private:
70 
72  DtPortalVrfTaskInteraction& operator = (
74 
76  bool operator == ( const DtPortalVrfTaskInteraction& ) const;
77 
79  bool operator != ( const DtPortalVrfTaskInteraction& ) const;
80 
81  };
82 
83 
85  {
86  return new DtPortalVrfTaskInteraction();
87  }
88 
89 }
#define DT_DLL_LIBPORTAL
Definition: include/portal/dllExport.h:20
#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: pVrfTask.h:84
The base class for all messages passed through the portal.
Definition: pMessage.h:65
Contains the DtPortalInteraction class declaration.
DtPortalInteractions are a special type of DtPortalMessages which are used to transmit simulation dat...
Definition: pInteraction.h:21
Vrf Scripted Task Interaction class.
Definition: pVrfTask.h:22
Connects a broker to the Portal Data Exchange.
Definition: pConnection.h:49
std::list< DtAttributeValuePair > DtAttributeValuePairList
A list of DtAttributeValuePairs.
Definition: variableLengthData.h:79
DtPortalMessageKind
A List of message kinds distributed with the Portal.
Definition: pMessageKinds.h:23
static const DtPortalMessageKind theKind
NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
Definition: pVrfTask.h:59

Document ID: Generated on Tue Aug 16 16:15:26 EDT 2022 from SVN revision 245901
Copyright © 2005-2022 MAK Technologies. All Rights Reserved (www.mak.com)