VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyPatchesRecord.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2013 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #pragma once
7 
9 #include "diguyPatchesRecordP.h"
10 
12 {
13 public:
14 
17 
20 
22  DtDiGuyPatchesRecord(void* netBuffer, unsigned int size);
23 
25  virtual DtDiGuyPatchesRecord& operator=(const DtDiGuyPatchesRecord& record);
26 
29 
31  virtual bool operator==(const DtDiGuyPatchesRecord& record);
32 
34  virtual bool operator==(const DtStandardVariableRecord& other);
35 
37 
38  virtual unsigned int recordType() const;
39  virtual void setRecordType(unsigned int recordType);
41 
43 
44  virtual unsigned int recordLength() const;
46  virtual void setRecordLength(unsigned int length);
48 
50 
51  virtual const char* name() const;
52  virtual void setName(const DtString& nameValue);
54 
56 
57  virtual unsigned int unit() const;
58  virtual void setUnit(unsigned int unitValue);
60 
62 
63  virtual unsigned personalUnit() const;
64  virtual void setPersonalUnit(unsigned int unitValue);
66 
68 
69  virtual short rank() const;
70  virtual void setRank(short rank);
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 void printDataToStream(std::ostream& stream) const;
83 
85  virtual unsigned int unpaddedNetsize() const;
86 
88  virtual DtStandardVariableRecord* clone() const;
89 
90 public:
91 
93  static DtStandardVariableRecord* create(void* addr, unsigned int length);
94 
96  static unsigned int recordTypeToUse();
97 
99  static void setRecordTypeToUse(unsigned int typeToUse);
100 
101 protected:
102 
103  std::vector<char> myRecordBuffer;
105  char* myNamePtr;
106 
107 protected:
108 
109  static const unsigned int theMinimumSize;
110 };
virtual void setName(const DtString &nameVal)
Set/Get name.
virtual void setFromNet(const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
Sets the record from an address and length.
virtual const char * name() const
Set/Get name.
virtual DtPatchIdentifier personalUnit() const
Set/Get personal unit.
virtual void setRecordLength(unsigned int length)
Must include size of record header and padding to 8 bytes.
virtual void setRank(const DtPatchIdentifier &patchId)
Set/Get rank.
virtual DtPatchIdentifier rank() const
Set/Get rank.
static const unsigned int theMinimumSize
Definition: diGuyPatchesRecord.h:110
virtual DtDiGuyPatchesRecord & operator=(const DtDiGuyPatchesRecord &record)
Assignment Operator.
virtual unsigned int recordLength() const
Get/Set Record Length.
static DtStandardVariableRecord * create(void *addr, unsigned int length)
Creator of an unknown record for registering in a factory.
virtual void setPersonalUnit(const DtPatchIdentifier &patchId)
Set/Get personal unit.
std::vector< char > myRecordBuffer
Definition: diGuyPatchesRecord.h:104
virtual void setRecordType(unsigned int recordType)
Get/Set Record Type.
virtual unsigned int recordType() const
Get/Set Record Type.
virtual void writeRecord(void *addr) const
static void setRecordTypeToUse(unsigned int typeToUse)
Set the record type to use.
virtual bool operator==(const DtDiGuyPatchesRecord &record)
Equals Operator.
virtual void setUnit(const DtPatchIdentifier &patchId)
Set/Get unit.
DtDiGuyPatchesRecord()
Constructor.
virtual unsigned int unpaddedNetsize() const
This is the network size of the record without padding.
Definition: include/vl/packets/diguyPatchesRecordP.h:16
virtual void printDataToStream(std::ostream &stream) const
Prints the data to the specified stream.
Definition: standardVariableRecord.h:22
DtNetDiguyPatchesRecord * myRecordPtr
Definition: diGuyPatchesRecord.h:105
DtStandardVariableRetCode
Definition: standardVariableRecord.h:14
Instances of DtString are used to represent strings.
Definition: vlString.h:29
virtual DtPatchIdentifier unit() const
Set/Get unit.
static unsigned int recordTypeToUse()
Return the DI-Guy Uniform Patch record type.
Definition: diGuyPatchesRecord.h:12
char * myNamePtr
Definition: diGuyPatchesRecord.h:106
virtual DtStandardVariableRecord * clone() const
Clone.

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)