VR-Link API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
statusRecord.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2023 MAK Technologies, Inc
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #pragma once
7 
11 #include <vlutil/vlUuid.h>
12 #include <vlpi/netnEnums.h>
13 
15 
16 
18 {
19 public:
20 
23 
25  DtStatusRecord(const DtStatusRecord& orig);
26 
28  DtStatusRecord(void* netBuffer, unsigned int size);
29 
31  virtual ~DtStatusRecord();
32 
34  virtual bool operator==(const DtStatusRecord& other);
35 
37  virtual bool operator==(const DtStandardVariableRecord& other);
38 
40 
41  virtual unsigned int recordType() const;
42  virtual void setRecordType(unsigned int recordType);
44 
46 
47  virtual unsigned int recordLength() const;
49  virtual void setRecordLength(unsigned int recordLength);
51 
52  virtual DtActiveStatusEnum status() const;
53 
54  virtual void setStatus(DtActiveStatusEnum status);
55 
57  virtual void printData() const;
58 
60  virtual void printDataToStream(std::ostream& stream) const;
61 
62  // Writes the network representation to the given address.
63  // The assumption is that this memory is allocated and is of the proper size.
64  virtual void writeRecord(void* addr) const;
65 
68  virtual void setFromNet(const void* netRecord, unsigned int length, DtStandardVariableRetCode* retCode = NULL);
69 
71  virtual unsigned unpaddedNetsize() const;
72 
74  virtual unsigned int netSize();
75 
77  virtual DtStandardVariableRecord* clone() const;
78 
80  static DtStandardVariableRecord* create(void* addr, unsigned int length);
81 
83  static unsigned int recordTypeToUse();
84 
85 
86 
87 protected:
90  static const unsigned int theMinimumSize;
91 };
#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.
DtActiveStatusEnum
Definition: netnEnums.h:13
Variable record for sending a status enum.
Definition: statusRecord.h:17
Definition: statusRecordP.h:16
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.
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.
DtNetStatusRecord myNetStatusRecord
Definition: statusRecord.h:89
virtual void writeRecord(void *addr) const =0
virtual unsigned int recordLength() const =0
Get/Set Record Length.
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:22
DtStandardVariableRetCode
Definition: standardVariableRecord.h:14
Contains the DtVrlUuid class declaration/definition.
DtActiveStatusEnum myVrlStatus
Definition: statusRecord.h:88
static const unsigned int theMinimumSize
Definition: statusRecord.h:90
This file contains typedefs for machine dependant types.
This file declares DtNetStatusRecord DtNetStatusRecord is an attribute record struct containing a 8 b...

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)