File: cmtkFileConstHeader.h

package info (click to toggle)
cmtk 3.3.1p2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,524 kB
  • sloc: cpp: 87,098; ansic: 23,347; sh: 3,896; xml: 1,551; perl: 707; makefile: 334
file content (126 lines) | stat: -rw-r--r-- 3,411 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 5436 $
//
//  $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkFileConstHeader_h_included_
#define __cmtkFileConstHeader_h_included_

#include <cmtkconfig.h>

#include <System/cmtkMemory.h>

#include <string.h>

namespace
cmtk
{

/** \addtogroup IO */
//@{

/** Read-only access to fields in a binary file header.
 */
class FileConstHeader
{
public:
  /// Constructor.
  FileConstHeader( const void *const header, const bool isBigEndian = true ) 
  {
    this->m_ConstHeader = static_cast<const char*>( header );
    this->m_IsBigEndian = isBigEndian;
  }
  
  /// Retrieve field of arbitrary type from header.
  template<class T> T GetField( const size_t offset ) 
  {
    T result;
    memcpy( &result, this->m_ConstHeader+offset, sizeof( T ) );
#ifdef WORDS_BIGENDIAN
    if ( ! this->m_IsBigEndian ) result = Memory::ByteSwap( result );
#else
    if ( this->m_IsBigEndian ) result = Memory::ByteSwap( result );
#endif
    return result;
  }

  /// Get null-terminated string from header.
  char* GetFieldString( const size_t offset, char* value, const size_t maxlen = 0 ) 
  {
    if ( maxlen )
      strncpy( value, this->m_ConstHeader+offset, maxlen );
    else
      strcpy( value, this->m_ConstHeader+offset );
    return value;
  }
  
  /** Compare n-character string.
   *\return The comparison result code as returned by memcmp(), i.e., the result is 0 if the given string matches
   * the respective portion of the header.
   */
  bool CompareFieldStringN( const size_t offset, const char* value, const size_t len ) const
  {
    return !memcmp( this->m_ConstHeader+offset, value, len );
  }
  
  /// Retrieve array of arbitrary type from header.
  template<class T> void GetArray
  ( T *const target, const size_t offset, const size_t length = 1 ) 
  {
    memcpy( target, this->m_ConstHeader+offset, length * sizeof( T ) );
#ifdef WORDS_BIGENDIAN
    if ( ! this->m_IsBigEndian ) 
      {
      for ( size_t i = 0; i < length; ++i ) 
	target[i] = Memory::ByteSwap( target[i] );
      }
#else
    if ( this->m_IsBigEndian ) 
      {
      for ( size_t i = 0; i < length; ++i ) 
	target[i] = Memory::ByteSwap( target[i] );
      }
#endif
  }
  
private:
  /// Pointer to the binary header.
  const char *m_ConstHeader;

protected:
  /// Flag for endianness.
  bool m_IsBigEndian;
};

//@}

} // namespace cmtk

#endif // #ifndef __cmtkFileConstHeader_h_included_