Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Functions | Variables
update_ResidueType_enum_files Namespace Reference

Classes

class  EnumInfo
 

Functions

def read_lines_from_file
 
def separate_definitions_from_comments
 
def write_lines_to_file_if_necessary
 
def Doxygen_info
 
def do_not_edit_warning
 
def generate_enum_header_file
 
def generate_mappings_source_file
 
def generate_files
 

Variables

list HEADER
 
list AUTHOR_AND_NOTE
 
list NAMESPACE_OPENING
 
list NAMESPACE_CLOSING
 
tuple properties = EnumInfo('ResidueProperty')
 
tuple variants = EnumInfo('VariantType')
 

Function Documentation

def update_ResidueType_enum_files.do_not_edit_warning (   short_name,
  filename 
)
Return lines providing a 'do not edit' comment warning.

Referenced by generate_enum_header_file(), and generate_mappings_source_file().

def update_ResidueType_enum_files.Doxygen_info (   filename,
  brief,
  additional_note = "" 
)
Return the lines of Doxygen info, given the filename and description.

Referenced by generate_enum_header_file(), and generate_mappings_source_file().

def update_ResidueType_enum_files.generate_enum_header_file (   enum_info,
  enum_defs,
  comments 
)
Write a header file from lists of enum definitions and their
corresponding comments, if the data have changed.

Return True if a new file has been written.

References do_not_edit_warning(), Doxygen_info(), protocols::sic_dock.range(), and write_lines_to_file_if_necessary().

Referenced by generate_files().

def update_ResidueType_enum_files.generate_files (   enum_info)
def update_ResidueType_enum_files.generate_mappings_source_file (   enum_info,
  enum_defs 
)
Write the _mappings.cc file from a list of enum values, if the
data have changed.

Return True if a new file has been written.

References do_not_edit_warning(), Doxygen_info(), and write_lines_to_file_if_necessary().

Referenced by generate_files().

def update_ResidueType_enum_files.read_lines_from_file (   filename)
Return each line of a file to a list.

Referenced by generate_files().

def update_ResidueType_enum_files.separate_definitions_from_comments (   lines_to_parse)
Parse each line by searching for a # symbol and return two lists.

Referenced by generate_files().

def update_ResidueType_enum_files.write_lines_to_file_if_necessary (   lines,
  filename 
)
Compare the existing file with the proposed new file and only write the
new file with different.

Return True if a new file has been written.

Referenced by generate_enum_header_file(), and generate_mappings_source_file().

Variable Documentation

list update_ResidueType_enum_files.AUTHOR_AND_NOTE
Initial value:
1 = [
2  '/// @author Labonte <JWLabonte@jhu.edu>\n',
3  '/// @author Vikram K. Mulligan (vmullig@uw.edu) -- updated for multi-threading\n',
4  '/// @note DO NOT EDIT THIS FILE DIRECTLY! It is auto-generated.\n',
5  '/// If you wish to edit it, modify the update_ResidueType_enum_files.py '
6  'script.\n']
list update_ResidueType_enum_files.HEADER
Initial value:
1 = [
2  '// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;'
3  'rm-trailing-spaces:t -*-\n',
4  '// vi: set ts=2 noet:\n',
5  '//\n',
6  '// (c) Copyright Rosetta Commons Member Institutions.\n',
7  '// (c) This file is part of the Rosetta software suite and is made '
8  'available under license.\n',
9  '// (c) The Rosetta software is developed by the contributing members of '
10  'the Rosetta Commons.\n',
11  '// (c) For more information, see http://www.rosettacommons.org. Questions '
12  'about this can be\n',
13  '// (c) addressed to University of Washington UW CoMotion, email: '
14  'license@uw.edu.\n',
15  "\n"]
list update_ResidueType_enum_files.NAMESPACE_CLOSING
Initial value:
1 = [
2  '} // namespace chemical\n',
3  '} // namespace core\n']
list update_ResidueType_enum_files.NAMESPACE_OPENING
Initial value:
1 = [
2  'namespace core {\n',
3  'namespace chemical {\n',
4  "\n"]
tuple update_ResidueType_enum_files.properties = EnumInfo('ResidueProperty')
tuple update_ResidueType_enum_files.variants = EnumInfo('VariantType')