Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/kogt/

RecordHolder.h
1 /**************************************************************************\
2  * Copyright (c) Kongsberg Oil & Gas Technologies AS
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 \**************************************************************************/
32 
33 #ifndef DIME_RECORDHOLDER_H
34 #define DIME_RECORDHOLDER_H
35 
36 #include <dime/Base.h>
37 
38 class dimeInput;
39 class dimeMemHandler;
40 class dimeOutput;
41 class dimeRecord;
42 
43 class DIME_DLL_API dimeRecordHolder : public dimeBase
44 {
45 public:
46  dimeRecordHolder(const int separator);
47  virtual ~dimeRecordHolder();
48 
49  void setRecord(const int groupcode, const dimeParam &value,
50  dimeMemHandler * const memhandler = NULL);
51  void setRecords(const int * const groupcodes,
52  const dimeParam * const params,
53  const int numrecords,
54  dimeMemHandler * const memhandler = NULL);
55  void setIndexedRecord(const int groupcode,
56  const dimeParam &value,
57  const int index,
58  dimeMemHandler * const memhandler = NULL);
59 
60  virtual bool getRecord(const int groupcode,
61  dimeParam &param,
62  const int index = 0) const;
63 
64  virtual bool read(dimeInput * const in);
65  virtual bool write(dimeOutput * const out);
66  virtual bool isOfType(const int thetypeid) const;
67  virtual int countRecords() const;
68 
69  dimeRecord *findRecord(const int groupcode, const int index = 0);
70 
71  int getNumRecordsInRecordHolder(void) const;
72  dimeRecord * getRecordInRecordHolder(const int idx) const;
73 
74 protected:
75  virtual bool handleRecord(const int groupcode,
76  const dimeParam &param,
77  dimeMemHandler * const memhandler);
78 
79  bool copyRecords(dimeRecordHolder * const rh,
80  dimeMemHandler * const memhandler) const;
81 
82  virtual bool shouldWriteRecord(const int groupcode) const;
83 
84 protected:
85  dimeRecord **records;
86  int numRecords;
87  // int separator; // not needed ?
88 
89 private:
90  void setRecordCommon(const int groupcode, const dimeParam &param,
91  const int index, dimeMemHandler * const memhandler);
92 
93 }; // class dimeRecordHolder
94 
95 #endif // ! DIME_RECORDHOLDER_H
96 
dimeRecordHolder::setRecord
void setRecord(const int groupcode, const dimeParam &value, dimeMemHandler *const memhandler=NULL)
Definition: RecordHolder.cpp:230
dimeRecordHolder::findRecord
dimeRecord * findRecord(const int groupcode, const int index=0)
Definition: RecordHolder.cpp:360
dimeArray< dimeRecord * >
dimeRecord
The dimeRecord class is the superclass of all record classes.
Definition: Record.h:43
dimeRecordHolder::~dimeRecordHolder
virtual ~dimeRecordHolder()
Definition: RecordHolder.cpp:68
dimeRecordHolder::read
virtual bool read(dimeInput *const in)
Definition: RecordHolder.cpp:119
dimeRecord::getValue
virtual void getValue(dimeParam &param) const =0
dimeInput::readGroupCode
bool readGroupCode(int32 &code)
Definition: Input.cpp:259
dimeRecordHolder::copyRecords
bool copyRecords(dimeRecordHolder *const rh, dimeMemHandler *const memhandler) const
Definition: RecordHolder.cpp:89
dimeInput::putBackGroupCode
void putBackGroupCode(const int32 code)
Definition: Input.cpp:323
dimeRecord::copy
virtual dimeRecord * copy(dimeMemHandler *const memhandler) const =0
dimeBase::isOfType
virtual bool isOfType(const int thetypeid) const
Definition: Base.cpp:116
dimeRecordHolder::setRecords
void setRecords(const int *const groupcodes, const dimeParam *const params, const int numrecords, dimeMemHandler *const memhandler=NULL)
Definition: RecordHolder.cpp:286
dimeRecordHolder::handleRecord
virtual bool handleRecord(const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
Definition: RecordHolder.cpp:204
dimeInput::getMemHandler
class dimeMemHandler * getMemHandler()
Definition: Input.cpp:586
dimeBase::typeId
virtual int typeId() const =0
dimeRecordHolder::dimeRecordHolder
dimeRecordHolder(const int separator)
Definition: RecordHolder.cpp:57
dimeInput
The dimeInput class offers transparent file I/O for DXF and DXB.
Definition: Input.h:41
dimeRecord::createRecord
static dimeRecord * createRecord(const int group_code, dimeMemHandler *const memhandler)
Definition: Record.cpp:173
dimeRecordHolder::isOfType
virtual bool isOfType(const int thetypeid) const
Definition: RecordHolder.cpp:78
dimeParam
The dimeParam class is a union of the different parameter types.
Definition: Basic.h:102
dimeBase
The dimeBase class is the superclass for most classes in Dime.
Definition: Base.h:41
dimeRecordHolder::countRecords
virtual int countRecords() const
Definition: RecordHolder.cpp:348
dimeRecordHolder::getNumRecordsInRecordHolder
int getNumRecordsInRecordHolder(void) const
Definition: RecordHolder.cpp:423
dimeArray::count
int count() const
Definition: Array.h:256
dimeRecord::setValue
virtual void setValue(const dimeParam &param, dimeMemHandler *const memhandler=NULL)=0
dimeMemHandler
The dimeMemHandler class is a special-purpose memory manager.
Definition: MemHandler.h:38
dimeRecordHolder::setIndexedRecord
void setIndexedRecord(const int groupcode, const dimeParam &value, const int index, dimeMemHandler *const memhandler=NULL)
Definition: RecordHolder.cpp:244
dimeOutput
The dimeOutput class handles writing of DXF and DXB files.
Definition: Output.h:41
dimeRecordHolder
The dimeRecordHolder class is a superclass for objects that store records.
Definition: RecordHolder.h:43
dimeRecordHolder::shouldWriteRecord
virtual bool shouldWriteRecord(const int groupcode) const
Definition: RecordHolder.cpp:379
dimeRecordHolder::getRecordInRecordHolder
dimeRecord * getRecordInRecordHolder(const int idx) const
Definition: RecordHolder.cpp:433
dimeRecord::readRecordData
static bool readRecordData(dimeInput *const in, const int group_code, dimeParam &param)
Definition: Record.cpp:367
dimeRecordHolder::write
virtual bool write(dimeOutput *const out)
Definition: RecordHolder.cpp:175
dimeRecordHolder::getRecord
virtual bool getRecord(const int groupcode, dimeParam &param, const int index=0) const
Definition: RecordHolder.cpp:261

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Tue Mar 24 2020 14:02:59 for Dime by Doxygen 1.8.17.