VR-Exchange 2.9 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
pVrfScenario.h
Go to the documentation of this file.
1 
2 /****************************************************************************
3  * Copyright (c) 2016 MAK Technologies, Inc.
4  * All rights reserved.
5  ****************************************************************************/
6 
10 
11 #pragma once
12 
13 #include <portal/dllExport.h>
14 #include <portal/pInteraction.h>
15 
16 namespace MAKVrExchange
17 {
18 
19  class DtPortalConnection;
20 
24  {
25  public:
26 
27  static const int DtNewScenarioType = 0;
28  static const int DtLoadScenarioType = 1;
29  static const int DtSaveScenarioType = 2;
30 
31  public:
32 
34  typedef void (*functionCallback_type) (
35  const DtPortalVrfScenarioInteraction &interaction, void *userData);
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 
55  DtDEC_ATTRIBUTE( DtString, ScenarioCommand, scenarioCommand );
56  DtDEC_ATTRIBUTE(DtString, ScenarioFilename, scenarioFilename);
57  DtDEC_ATTRIBUTE(DtString, Address, address);
58 
60 
62  public:
63 
65 
66  static DtPortalMessage* create();
67 
68  virtual unsigned int netSize() const;
69  virtual void writeSelfToBuffer( void* buffer, int bufferSize ) const;
70  virtual void readSelfFromBuffer( const void* buffer, int bufferSize );
71 
72  virtual std::ostream& printDataToStream( std::ostream& stream ) const;
73 
74  private:
75 
78 
80  bool operator == ( const DtPortalVrfScenarioInteraction& ) const;
81 
83  bool operator != ( const DtPortalVrfScenarioInteraction& ) const;
84 
85  };
86 
87 
89  {
90  return new DtPortalVrfScenarioInteraction();
91  }
92 
93 }
Vrf Scenario Interaction class.
Definition: pVrfScenario.h:23
#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
The base class for all messages passed through the portal.
Definition: pMessage.h:66
Contains the DtPortalInteraction class declaration.
DtPortalInteractions are a special type of DtPortalMessages which are used to transmit simulation dat...
Definition: pInteraction.h:21
static DtPortalMessage * create()
Definition: pVrfScenario.h:88
Connects a broker to the Portal Data Exchange.
Definition: pConnection.h:49
static const DtPortalMessageKind theKind
NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
Definition: pVrfScenario.h:64
DtPortalMessageKind
A List of message kinds distributed with the Portal.
Definition: pMessageKinds.h:23

Document ID: Generated on Tue Jun 25 16:45:35 EDT 2024 from SVN revision 267383
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)