OpenCMISS-Iron Internal API Documentation
binary_file_f.f90 File Reference

This module handles the reading and writing of binary files. More...

Go to the source code of this file.

Data Types

type  binary_file::binary_file_info_type
 
type  binary_file::binary_file_type
 
type  binary_file::binary_tag_type
 
interface  binary_file::BINARYCLOSEFILE
 
interface  binary_file::BINARYOPENFILE
 
interface  binary_file::BINARYSETFILE
 
interface  binary_file::BINARYSKIPFILE
 
interface  binary_file::ISBINARYFILEOPEN
 
interface  binary_file::ISENDBINARYFILE
 
interface  binary_file::read_binary_file
 
interface  binary_file::write_binary_file
 

Modules

module  binary_file
 This module handles the reading and writing of binary files.
 

Functions/Subroutines

logical function binary_file::inquire_open_binary_file (FILEID)
 
logical function binary_file::inquire_eof_binary_file (FILEID, ERR, ERROR)
 
subroutine binary_file::close_binary_file (FILEID, ERR, ERROR,)
 
subroutine binary_file::close_cmiss_binary_file (FILEID, ERR, ERROR,)
 
subroutine binary_file::open_binary_file (FILEID, COMMAND, FILENAME, ERR, ERROR,)
 
subroutine binary_file::open_cmiss_binary_file (FILEID, FILE_TYPE, NUMBER_TAGS, VERSION, FILEVERSION, COMMAND, EXTENSION, FILENAME, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_intg (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_intg1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_sintg (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_sintg1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_lintg (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_lintg1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_sp (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_sp1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_dp (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_dp1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_character (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_logical (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_logical1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_spc (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_spc1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_dpc (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_file_dpc1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::read_binary_tag_header (FILEID, TAG, ERR, ERROR,)
 
subroutine binary_file::reset_binary_number_tags (FILEID, NUMBER_TAGS, ERR, ERROR,)
 
subroutine binary_file::set_binary_file (FILEID, SET_CODE, ERR, ERROR,)
 
subroutine binary_file::skip_cm_binary_header (FILEID, SKIP, ERR, ERROR,)
 
subroutine binary_file::skip_binary_file (FILEID, NUMBER_BYTES, ERR, ERROR,)
 
recursive subroutine binary_file::skip_binary_tags (FILEID, TAG, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_intg (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_intg1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_sintg (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_sintg1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_lintg (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_lintg1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_sp (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_sp1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_dp (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_dp1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_character (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_logical (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_logical1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_spc (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_spc1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_dpc (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_file_dpc1 (FILEID, NUM_DATA, DATA, ERR, ERROR,)
 
subroutine binary_file::write_binary_tag_header (FILEID, TAG, ERR, ERROR,)
 

Variables

integer(intg), parameter binary_file::max_num_binary_files =99
 
integer(intg), parameter, public binary_file::file_beginning =0
 
integer(intg), parameter, public binary_file::file_current =1
 
integer(intg), parameter, public binary_file::file_end =2
 
integer(intg), parameter binary_file::file_same_endian =0
 
integer(intg), parameter binary_file::file_change_endian =1
 
integer(intg), parameter binary_file::binary_file_readable =1
 
integer(intg), parameter binary_file::binary_file_writable =2
 
integer(intg), parameter binary_file::cmiss_binary_identity =7
 
integer(intg), parameter, public binary_file::cmiss_binary_matrix_file =1
 
integer(intg), parameter, public binary_file::cmiss_binary_history_file =2
 
integer(intg), parameter, public binary_file::cmiss_binary_signal_file =3
 
integer(intg), parameter binary_file::cmiss_binary_identity_header =1
 
integer(intg), parameter binary_file::cmiss_binary_machine_header =2
 
integer(intg), parameter binary_file::cmiss_binary_file_header =3
 
logical, dimension(max_num_binary_files), save binary_file::binary_file_used =.FALSE.
 

Detailed Description

This module handles the reading and writing of binary files.

Author
Chris Bradley
Todo:
Fix naming convention and update to current code standard.

LICENSE

Version: MPL 1.1/GPL 2.0/LGPL 2.1

The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The Original Code is OpenCMISS

The Initial Developer of the Original Code is University of Auckland, Auckland, New Zealand, the University of Oxford, Oxford, United Kingdom and King's College, London, United Kingdom. Portions created by the University of Auckland, the University of Oxford and King's College, London are Copyright (C) 2007-2010 by the University of Auckland, the University of Oxford and King's College, London. All Rights Reserved.

Contributor(s):

Alternatively, the contents of this file may be used under the terms of either the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the MPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the MPL, the GPL or the LGPL.

Definition in file binary_file_f.f90.