VR-Link API Documentation for HLA Evolved
 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) 2021 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
6 #pragma once
7 
10 #include <vlpi/patchIdentifier.h>
11 
13 {
14 public:
15 
18 
21 
23  DtDiGuyPatchesRecord( void* netBuffer, unsigned int size );
24 
26  virtual DtDiGuyPatchesRecord& operator = ( const DtDiGuyPatchesRecord& record );
27 
30 
32  virtual bool operator == ( const DtDiGuyPatchesRecord& record );
33 
35  virtual bool operator == ( const DtStandardVariableRecord& other );
36 
39  virtual unsigned int recordType() const;
40  virtual void setRecordType( unsigned int recordType );
42 
45  virtual unsigned int recordLength() const;
47  virtual void setRecordLength( unsigned int length );
49 
52  virtual void setUnit( const DtPatchIdentifier& patchId );
53  virtual DtPatchIdentifier unit() const;
55 
58  virtual void setPersonalUnit( const DtPatchIdentifier& patchId );
59  virtual DtPatchIdentifier personalUnit() const;
61 
64  virtual void setRank( const DtPatchIdentifier& patchId );
65  virtual DtPatchIdentifier rank() const;
67 
70  virtual void setName( const DtString& nameVal );
71  virtual const char* name() const;
73 
74  // Writes the network representation to the given address.
75  // The assumption is that this memory is allocated and is of the proper size.
76  virtual void writeRecord( void* addr ) const;
77 
80  virtual void setFromNet( const void* netRecord, unsigned int length, DtStandardVariableRetCode* retCode = NULL );
81 
83  virtual void printDataToStream( std::ostream& stream ) const;
84 
86  virtual unsigned int unpaddedNetsize() const;
87 
89  virtual DtStandardVariableRecord* clone() const;
90 
91 public:
92 
94  static DtStandardVariableRecord* create(void* addr, unsigned int length);
95 
97  static unsigned int recordTypeToUse();
98 
100  static void setRecordTypeToUse(unsigned int typeToUse);
101 
102 protected:
103 
104  std::vector<char> myRecordBuffer;
106  char* myNamePtr;
107 
108 protected:
109 
110  static const unsigned int theMinimumSize;
111 
112 };
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.
DtPatchIdentifier is used to uniquely identify a uniform patch.
Definition: patchIdentifier.h:18
virtual void setUnit(const DtPatchIdentifier &patchId)
Set/Get unit.
Contains the DtPatchIdentifier class declaration.
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 Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)