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 )

References generate_enum_header_file(), generate_mappings_source_file(), read_lines_from_file(), and separate_definitions_from_comments().

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:

 = [
     '/// @author  Labonte <JWLabonte@jhu.edu>\n',
     '/// @author  Vikram K. Mulligan (vmullig@uw.edu) -- updated for multi-threading\n',
     '/// @note    DO NOT EDIT THIS FILE DIRECTLY!  It is auto-generated.\n',
     '/// If you wish to edit it, modify the update_ResidueType_enum_files.py '
                                                                     'script.\n']

list update_ResidueType_enum_files.HEADER

Initial value:

 = [
     '// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;'
                                                    'rm-trailing-spaces:t -*-\n',
     '// vi: set ts=2 noet:\n',
     '//\n',
     '// (c) Copyright Rosetta Commons Member Institutions.\n',
     '// (c) This file is part of the Rosetta software suite and is made '
                                                    'available under license.\n',
     '// (c) The Rosetta software is developed by the contributing members of '
                                                        'the Rosetta Commons.\n',
     '// (c) For more information, see http://www.rosettacommons.org. Questions '
                                                           'about this can be\n',
     '// (c) addressed to University of Washington UW CoMotion, email: '
                                                   'license@uw.edu.\n',
     "\n"]

list update_ResidueType_enum_files.NAMESPACE_CLOSING

Initial value:

 = [
     '}  // namespace chemical\n',
     '}  // namespace core\n']

list update_ResidueType_enum_files.NAMESPACE_OPENING

Initial value:

 = [
     'namespace core {\n',
     'namespace chemical {\n',
     "\n"]

tuple update_ResidueType_enum_files.properties = EnumInfo('ResidueProperty')

tuple update_ResidueType_enum_files.variants = EnumInfo('VariantType')

Referenced by core::pack::palette::PackerPalette.decide_what_to_do_with_base_type(), core::pack::palette::PackerPalette.decide_what_to_do_with_existing_type(), core::chemical::Patch.deletes_variants(), core::chemical::PatchCase.deletes_variants_by_enum(), core::chemical::Patch.deletes_variants_by_enum(), core::chemical::ResidueTypeSet.get_representative_type_aa(), core::chemical::ResidueTypeSet.get_representative_type_name1(), core::chemical::ResidueTypeSet.get_representative_type_name3(), core::conformation.get_residue_from_name1(), core::pack::palette::PackerPalette.get_residue_type_cop_with_variant_removed(), core::chemical::ResidueTypeSet.get_residue_type_with_custom_variant_added(), core::chemical::ResidueTypeSet.get_residue_type_with_variant_added(), core::chemical::ResidueTypeSet.get_residue_type_with_variant_removed(), core::io::pose_from_sfr::PoseFromSFRBuilder.get_rsd_type(), core::pose.get_rsd_type_from_aa(), core::chemical::carbohydrates::CarbohydrateInfo.read_and_set_properties(), core::chemical::ResidueProperties.show(), core::pose::carbohydrates.tautomerize_anomer(), core::pose::Pose.virtual_to_real(), and core::chemical.write_topology_file().

Classes

Functions

Variables

Function Documentation

Variable Documentation