VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ifEmbeddedEntityInfoCacheResponse.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
9 
10 #pragma once
11 
12 #include "vrfmsgs/vrfmsgsDefines.h"
13 
15 
17 #include <vlpi/entityType.h>
18 
19 class DtEntityType;
20 
24  DtEntityType myEmbeddedEntityType;
25 };
26 
30 public:
31 
34  virtual ~DtIfEmbeddedEntityInfoCacheResponse() override;
36 
37  virtual DtSimInterfaceContent* clone() const override;
38  virtual int type() const override;
39 
42  virtual int netRepSize() const override;
43  virtual bool setFromNet(const char* buff, unsigned contentSize) override;
44  virtual bool setToNet() override;
46 
47  virtual void printDataToString(DtString& str) override;
48 
49  static DtSimInterfaceContent* creator();
50 
53  virtual void setObjectTypeRequested(const DtEntityType& objType);
54  virtual const DtEntityType& objectTypeRequested() const;
56 
59  virtual void setCacheMissed(const bool& missed);
60  virtual const bool cacheMissed() const;
62 
65  virtual void setEmbeddedEntities(const std::vector<DtEmbeddedEntity>& eeVector);
66  virtual const std::vector<DtEmbeddedEntity>& embeddedEntities() const;
68 
71  virtual void setAvailableSets(const std::vector<DtSetMessageType>& setsVector);
72  virtual const std::vector<DtSetMessageType>& availableSets() const;
74 
77  virtual void setAvailableTasks(const std::vector<DtSimTaskMessageType>& tasksVector);
78  virtual const std::vector<DtSimTaskMessageType>& availableTasks() const;
80 
81 protected:
82 
84  DtEntityType myObjectTypeRequested;
88 
91  std::vector<DtEmbeddedEntity> myEmbeddedEntities;
92  std::vector<DtSetMessageType> myAvailableSets;
93  std::vector<DtSimTaskMessageType> myAvailableTasks;
95 };
96 
100 DT_DLL_vrfmsgs char* encode(const DtEmbeddedEntity& ee, char* buff);
101 DT_DLL_vrfmsgs const char* decode(DtEmbeddedEntity&ee, const char* buff);
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Definition: simInterfaceContent.h:78
virtual int netRepSize() const
Definition: simInterfaceContent.h:76
DT_DLL_readerWriter int getSize(const DtString &val)
The number of bytes required to encode the value.
Name &lt;-&gt; type pair representing the API-exposed portion of an Embedded Entity configuration.
Definition: ifEmbeddedEntityInfoCacheResponse.h:22
#define DT_DLL_vrfmsgs
This file is used to determine how to build.
Definition: vrfmsgsDefines.h:28
virtual int type() const =0
The message type sent to the front-end in reply to cache-update requests on object type keyed data...
Definition: ifEmbeddedEntityInfoCacheResponse.h:29
virtual void printDataToString(DtString &str)
std::vector< DtSimTaskMessageType > myAvailableTasks
Cached data available for the type.
Definition: ifEmbeddedEntityInfoCacheResponse.h:93
const DtSimInterfaceContent & operator=(const DtSimInterfaceContent &orig)
DtEntityType myObjectTypeRequested
Object type originally requested &amp; thus the type applicable to this reply.
Definition: ifEmbeddedEntityInfoCacheResponse.h:84
Define constants for types of tasks, sets, admin messages, reports, and sim commands (all sent via ra...
DT_DLL_readerWriter char * encode(const DtFilename &val, char *buffer)
Serializes the provided value val into buffer. buffer must have at least the number of bytes returned...
DtString myEmbeddedEntityName
Definition: ifEmbeddedEntityInfoCacheResponse.h:23
DtEntityType myEmbeddedEntityType
Definition: ifEmbeddedEntityInfoCacheResponse.h:24
std::vector< DtEmbeddedEntity > myEmbeddedEntities
Cached data available for the type.
Definition: ifEmbeddedEntityInfoCacheResponse.h:91
bool myCacheMissed
True if the requested type does not have cached data. Provided as empty vectors do not necessarily in...
Definition: ifEmbeddedEntityInfoCacheResponse.h:87
virtual bool setToNet()
Definition: simInterfaceContent.h:83
Definition: simInterfaceContent.h:45
DT_DLL_readerWriter const char * decode(DtString &val, const char *buffer)
Decodes a value from buffer and places the result in val of the type specified by val...
virtual DtSimInterfaceContent * clone() const =0
std::vector< DtSetMessageType > myAvailableSets
Cached data available for the type.
Definition: ifEmbeddedEntityInfoCacheResponse.h:92

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)