Inheritance diagram for tools::wroot::key:

Public Member Functions
	key (std::ostream &a_out, seek a_seek_directory, const std::string &a_object_name, const std::string &a_object_title, const std::string &a_object_class)

	key (std::ostream &a_out, ifile &a_file, seek a_seek_directory, const std::string &a_object_name, const std::string &a_object_title, const std::string &a_object_class, uint32 a_object_size)

virtual	~key ()

uint16	cycle () const

void	set_cycle (uint16 a_cycle)

const std::string &	object_name () const

const std::string &	object_title () const

const std::string &	object_class () const

bool	write_self (ifile &a_file)

bool	write_file (ifile &a_file, uint32 &a_nbytes)

void	set_number_of_bytes (uint32 a_n)

uint32	number_of_bytes () const

uint32	object_size () const

seek	seek_key () const

short	key_length () const

char *	data_buffer ()

const char *	eob () const

bool	to_buffer (wbuf &a_wb, bool a_verbose) const

Static Public Member Functions
static unsigned int	std_string_record_size (const std::string &x)

Protected Member Functions
	key (const key &a_from)

key &	operator= (const key &)

uint32	record_size (uint32 a_version) const

bool	initialize_zero ()

bool	initialize (ifile &a_file, uint32 a_nbytes)

Protected Attributes
std::ostream &	m_out

uint32	m_buf_size

char *	m_buffer

uint32	m_nbytes

uint32	m_version

uint32	m_object_size

date	m_date

uint16	m_key_length

uint16	m_cycle

seek	m_seek_key

seek	m_seek_directory

std::string	m_object_class

std::string	m_object_name

std::string	m_object_title

Detailed Description

Definition at line 22 of file key.

Constructor & Destructor Documentation

◆ key() [1/3]

tools::wroot::key::key	(	std::ostream &	a_out,
		seek	a_seek_directory,
		const std::string &	a_object_name,
		const std::string &	a_object_title,
		const std::string &	a_object_class
	)

inline

Definition at line 37 of file key.

   :m_out(a_out)
   ,m_buf_size(0)
   ,m_buffer(0)
   // Record :
   ,m_nbytes(0)
   ,m_version(class_version())
   ,m_object_size(0)
   ,m_date(0)
   ,m_key_length(0)
   ,m_cycle(0)
   ,m_seek_key(0)
   ,m_seek_directory(0)
   ,m_object_class(a_object_class)
   ,m_object_name(a_object_name)
   ,m_object_title(a_object_title)
   {
 #ifdef TOOLS_MEM
     mem::increment(s_class().c_str());
 #endif
  
     if(a_seek_directory>START_BIG_FILE()) m_version += big_file_version_tag();
  
     m_key_length = record_size(m_version);
  
     initialize_zero();
  
     m_seek_directory = a_seek_directory;
   }

◆ key() [2/3]

tools::wroot::key::key	(	std::ostream &	a_out,
		ifile &	a_file,
		seek	a_seek_directory,
		const std::string &	a_object_name,
		const std::string &	a_object_title,
		const std::string &	a_object_class,
		uint32	a_object_size
	)

inline

Definition at line 71 of file key.

   :m_out(a_out)
   ,m_buf_size(0)
   ,m_buffer(0)
   // Record :
   ,m_nbytes(0)
   ,m_version(class_version())
   ,m_object_size(a_object_size)
   ,m_date(0)
   ,m_key_length(0)
   ,m_cycle(0)
   ,m_seek_key(0)
   ,m_seek_directory(0)
   ,m_object_class(a_object_class)
   ,m_object_name(a_object_name)
   ,m_object_title(a_object_title)
   {
 #ifdef TOOLS_MEM
     mem::increment(s_class().c_str());
 #endif
  
     if(a_object_size) {
       if(a_file.END()>START_BIG_FILE()) m_version += big_file_version_tag();
     }
     if(m_version>big_file_version_tag()) {
     } else {
       if(a_seek_directory>START_BIG_FILE()) m_version += big_file_version_tag();
     }
  
     m_key_length = record_size(m_version);
  
     initialize(a_file,a_object_size);
  
     m_seek_directory = a_seek_directory;
   }

◆ ~key()

virtual tools::wroot::key::~key ( )

inlinevirtual

Definition at line 112 of file key.

                 {
     delete [] m_buffer;
 #ifdef TOOLS_MEM
     mem::decrement(s_class().c_str());
 #endif
   }

◆ key() [3/3]

tools::wroot::key::key ( const key & a_from )

inlineprotected

Definition at line 119 of file key.

                         :m_out(a_from.m_out){
 #ifdef TOOLS_MEM
     mem::increment(s_class().c_str());
 #endif
   }

Member Function Documentation

◆ cycle()

uint16 tools::wroot::key::cycle ( ) const

inline

Definition at line 126 of file key.

126 {return m_cycle;}

◆ data_buffer()

char* tools::wroot::key::data_buffer ( )

inline

Definition at line 174 of file key.

174 {return m_buffer + m_key_length;}

◆ eob()

const char* tools::wroot::key::eob ( ) const

inline

Definition at line 175 of file key.

175 {return m_buffer + m_buf_size;}

◆ initialize()

bool tools::wroot::key::initialize	(	ifile &	a_file,
		uint32	a_nbytes
	)

inlineprotected

Definition at line 255 of file key.

                                                  {
     uint32 nsize = m_key_length+a_nbytes;
  
     m_date = get_date();
  
     if(a_nbytes) {//GB
       m_seek_key = a_file.END();
       a_file.set_END(m_seek_key+nsize);
  
       //NOTE : the free segment logic found in CERN-ROOT/TKey
       //       is not yet needed right now for us, since
       //       we always write at end of file. The update
       //       of the eof free_seg is done in set_END.
     } else { //basket
       m_seek_key = 0;
     }
  
     delete [] m_buffer;
     m_buffer = new char[nsize];
     m_buf_size = nsize;
     m_nbytes = nsize;
  
     return true;
   }

◆ initialize_zero()

bool tools::wroot::key::initialize_zero ( )

inlineprotected

Definition at line 245 of file key.

                          {
     uint32 nsize = m_key_length;
     m_date = get_date();
     m_seek_key = 0;
     delete [] m_buffer;
     m_buffer = new char[nsize];
     m_buf_size = nsize;
     m_nbytes = nsize;
     return true;
   }

◆ key_length()

short tools::wroot::key::key_length ( ) const

inline

Definition at line 172 of file key.

172 {return m_key_length;}

◆ number_of_bytes()

uint32 tools::wroot::key::number_of_bytes ( ) const

inline

Definition at line 167 of file key.

167 {return m_nbytes;}

◆ object_class()

const std::string& tools::wroot::key::object_class ( ) const

inline

Definition at line 131 of file key.

131 {return m_object_class;}

◆ object_name()

const std::string& tools::wroot::key::object_name ( ) const

inline

Definition at line 129 of file key.

129 {return m_object_name;}

◆ object_size()

uint32 tools::wroot::key::object_size ( ) const

inline

Definition at line 169 of file key.

169 {return m_object_size;}

◆ object_title()

const std::string& tools::wroot::key::object_title ( ) const

inline

Definition at line 130 of file key.

130 {return m_object_title;}

◆ operator=()

key& tools::wroot::key::operator= ( const key & )

inlineprotected

Definition at line 124 of file key.

124 {return *this;}

◆ record_size()

uint32 tools::wroot::key::record_size ( uint32 a_version ) const

inlineprotected

Definition at line 224 of file key.

                                              {
     // Return the size in bytes of the key header structure.
     uint32 nbytes = sizeof(m_nbytes);
     nbytes += sizeof(short);
     nbytes += sizeof(m_object_size);
     nbytes += sizeof(date);
     nbytes += sizeof(m_key_length);
     nbytes += sizeof(m_cycle);
     if(a_version>big_file_version_tag()) {
       nbytes += sizeof(seek);
       nbytes += sizeof(seek);
     } else {
       nbytes += sizeof(seek32);
       nbytes += sizeof(seek32);
     }
     nbytes += std_string_record_size(m_object_class);
     nbytes += std_string_record_size(m_object_name);
     nbytes += std_string_record_size(m_object_title);
     return nbytes;
   }

◆ seek_key()

seek tools::wroot::key::seek_key ( ) const

inline

Definition at line 171 of file key.

171 {return m_seek_key;}

◆ set_cycle()

void tools::wroot::key::set_cycle ( uint16 a_cycle )

inline

Definition at line 127 of file key.

127 {m_cycle = a_cycle;}

◆ set_number_of_bytes()

void tools::wroot::key::set_number_of_bytes ( uint32 a_n )

inline

Definition at line 166 of file key.

166 {m_nbytes = a_n;}

◆ std_string_record_size()

static unsigned int tools::wroot::key::std_string_record_size ( const std::string & x )

inlinestatic

Definition at line 29 of file key.

                                                                  {
     // Returns size string will occupy on I/O buffer.
     if (x.size() > 254)
       return uint32(x.size()+sizeof(unsigned char)+sizeof(int));
     else
       return uint32(x.size()+sizeof(unsigned char));
   }

◆ to_buffer()

bool tools::wroot::key::to_buffer	(	wbuf &	a_wb,
		bool	a_verbose
	)		const

inline

Definition at line 177 of file key.

                                                   {
     if(!a_wb.write(m_nbytes)) return false;
     short version = m_version;
     if(!a_wb.write(version)) return false;
     if(!a_wb.write(m_object_size)) return false;
     unsigned int _date = 0; //FIXME
     if(!a_wb.write(_date)) return false;
     if(!a_wb.write(m_key_length)) return false;
     if(!a_wb.write(m_cycle)) return false;
     if(version>(short)big_file_version_tag()) {
       if(!a_wb.write(m_seek_key)) return false;
       if(!a_wb.write(m_seek_directory)) return false;
     } else {
       if(m_seek_key>START_BIG_FILE()) {
         m_out << "tools::wroot::key::to_buffer :"
               << " attempt to write big seek "
               << m_seek_key << " on 32 bits."
               << std::endl;
         return false;
       }
       if(!a_wb.write((seek32)m_seek_key)) return false;
       if(m_seek_directory>START_BIG_FILE()) {
         m_out << "tools::wroot::key::to_buffer :"
               << " (2) attempt to write big seek "
               << m_seek_directory << " on 32 bits."
               << std::endl;
         return false;
       }
       if(!a_wb.write((seek32)m_seek_directory)) return false;
     }
     if(!a_wb.write(m_object_class)) return false;
     if(!a_wb.write(m_object_name)) return false;
     if(!a_wb.write(m_object_title)) return false;
     if(a_verbose) {
       m_out << "tools::wroot::key::to_buffer :"
             << " nbytes : " << m_nbytes
             << ", object class : " << sout(m_object_class)
             << ", object name : " << sout(m_object_name)
             << ", object title : " << sout(m_object_title)
             << ", object size : " << m_object_size
             << "."
             << std::endl;
     }
     return true;
   }

◆ write_file()

bool tools::wroot::key::write_file	(	ifile &	a_file,
		uint32 &	a_nbytes
	)

inline

Definition at line 139 of file key.

                                                   {
     if(!a_file.set_pos(m_seek_key)) {
       a_nbytes = 0;
       return false;
     }
     if(!a_file.write_buffer(m_buffer,m_nbytes)) {
       a_nbytes = 0;
       return false;
     }
  
     if(a_file.verbose()) {
       m_out << "tools::wroot::key::write_file :"
             << " writing " << m_nbytes << " bytes"
             << " at address " << m_seek_key
             << " for ID=" << sout(m_object_name)
             << " Title=" << sout(m_object_title) << "."
             << std::endl;
     }
  
     delete [] m_buffer; //???
     m_buffer = 0;
     m_buf_size = 0;
  
     a_nbytes = m_nbytes;
     return true;
   }

◆ write_self()

bool tools::wroot::key::write_self ( ifile & a_file )

inline

Definition at line 133 of file key.

                                  {
     char* buffer = m_buffer;
     wbuf wb(m_out,a_file.byte_swap(),eob(),buffer);
     return to_buffer(wb,a_file.verbose());
   }

Member Data Documentation

◆ m_buf_size

uint32 tools::wroot::key::m_buf_size

protected

Definition at line 281 of file key.

◆ m_buffer

char* tools::wroot::key::m_buffer

protected

Definition at line 282 of file key.

◆ m_cycle

uint16 tools::wroot::key::m_cycle

protected

Definition at line 289 of file key.

◆ m_date

date tools::wroot::key::m_date

protected

Definition at line 287 of file key.

◆ m_key_length

uint16 tools::wroot::key::m_key_length

protected

Definition at line 288 of file key.

◆ m_nbytes

uint32 tools::wroot::key::m_nbytes

protected

Definition at line 284 of file key.

◆ m_object_class

std::string tools::wroot::key::m_object_class

protected

Definition at line 292 of file key.

◆ m_object_name

std::string tools::wroot::key::m_object_name

protected

Definition at line 293 of file key.

◆ m_object_size

uint32 tools::wroot::key::m_object_size

protected

Definition at line 286 of file key.

◆ m_object_title

std::string tools::wroot::key::m_object_title

protected

Definition at line 294 of file key.

◆ m_out

std::ostream& tools::wroot::key::m_out

protected

Definition at line 280 of file key.

◆ m_seek_directory

seek tools::wroot::key::m_seek_directory

protected

Definition at line 291 of file key.

◆ m_seek_key

seek tools::wroot::key::m_seek_key

protected

Definition at line 290 of file key.

◆ m_version

uint32 tools::wroot::key::m_version

protected

Definition at line 285 of file key.

The documentation for this class was generated from the following file:

/Users/barrand/private/dev/softinex/g4tools/g4tools/tools/wroot/key

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ key() [1/3]

◆ key() [2/3]

◆ ~key()

◆ key() [3/3]

Member Function Documentation

◆ cycle()

◆ data_buffer()

◆ eob()

◆ initialize()

◆ initialize_zero()

◆ key_length()

◆ number_of_bytes()

◆ object_class()

◆ object_name()

◆ object_size()

◆ object_title()

◆ operator=()

◆ record_size()

◆ seek_key()

◆ set_cycle()

◆ set_number_of_bytes()

◆ std_string_record_size()

◆ to_buffer()

◆ write_file()

◆ write_self()

Member Data Documentation

◆ m_buf_size

◆ m_buffer

◆ m_cycle

◆ m_date

◆ m_key_length

◆ m_nbytes

◆ m_object_class

◆ m_object_name

◆ m_object_size

◆ m_object_title

◆ m_out

◆ m_seek_directory

◆ m_seek_key

◆ m_version