VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
symbolIdRecord.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2025 MAK Technologies, Inc
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #pragma once
7 
11 #include <vlutil/vlUuid.h>
12 #include <vlpi/netnEnums.h>
14 
16 
17 
19 {
20 public:
21 
24 
27 
29  DtSymbolIdRecord(void* netBuffer, unsigned int size);
30 
32  virtual ~DtSymbolIdRecord();
33 
35  virtual bool operator==(const DtSymbolIdRecord& other);
36 
38  virtual bool operator==(const DtStandardVariableRecord& other);
39 
41 
42  virtual unsigned int recordType() const;
43  virtual void setRecordType(unsigned int recordType);
45 
47 
48  virtual unsigned int recordLength() const;
50  virtual void setRecordLength(unsigned int recordLength);
52 
54 
55  virtual unsigned int stringLength() const;
57  virtual void setStringLength(unsigned int stringLength);
59 
61 
62  virtual std::wstring symbolId() const;
64  virtual void setSymbolId(const std::wstring& symbolId);
66 
68  virtual void printData() const;
69 
71  virtual void printDataToStream(std::ostream& stream) const;
72 
73  // Writes the network representation to the given address.
74  // The assumption is that this memory is allocated and is of the proper size.
75  virtual void writeRecord(void* addr) const;
76 
79  virtual void setFromNet(const void* netRecord, unsigned int length, DtStandardVariableRetCode* retCode = NULL);
80 
82  virtual unsigned unpaddedNetsize() const;
83 
85  virtual unsigned int netSize();
86 
88  virtual DtStandardVariableRecord* clone() const;
89 
91  static DtStandardVariableRecord* create(void* addr, unsigned int length);
92 
94  static unsigned int recordTypeToUse();
95 
96 
97 protected:
98  std::wstring mySymbolId;
100  static const unsigned int theMinimumSize;
101  mutable int mySymbolIdPadding;
102 };
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
virtual unsigned unpaddedNetsize() const =0
This is the network size of the record without padding.
Contains the standard NETN enumerations.
virtual unsigned int netSize()
Returns the size of the network representation (including padding bytes)
virtual DtStandardVariableRecord * clone() const =0
Clone.
virtual void setRecordLength(unsigned int recordLength)=0
Must include size of record header and padding to 8 bytes.
static const unsigned int theMinimumSize
Definition: symbolIdRecord.h:100
virtual void printData() const
Prints the data to DtInfo.
virtual void printDataToStream(std::ostream &stream) const =0
Prints the data to the specified stream.
virtual bool operator==(const DtStandardVariableRecord &other)=0
Equals operator.
std::wstring mySymbolId
Definition: symbolIdRecord.h:98
This file declares DtNetSymbolIdRecord DtNetSymbolIdRecord is an attribute record struct containing a...
virtual void writeRecord(void *addr) const =0
virtual unsigned int recordLength() const =0
Get/Set Record Length.
int mySymbolIdPadding
Definition: symbolIdRecord.h:101
virtual unsigned int recordType() const =0
Get/Set Record Type.
virtual void setRecordType(unsigned int recordType)=0
Get/Set Record Type.
virtual void setFromNet(const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)=0
Sets the record from Network Representation from the given location.
Definition: standardVariableRecord.h:23
DtStandardVariableRetCode
Definition: standardVariableRecord.h:15
DtNetSymbolIdRecord myNetSymbolIdRecord
Definition: symbolIdRecord.h:99
Contains the DtVrlUuid class declaration/definition.
This file contains typedefs for machine dependant types.
Definition: symbolIdRecordP.h:17
Variable record for sending the SymbolId string.
Definition: symbolIdRecord.h:18

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)