The implementation for String, the ARTS string class. More...
#include <mystring.h>
Public Types | |
| typedef Index | size_type |
Public Member Functions | |
| my_basic_string ()=default | |
| my_basic_string (Index n, char c=' ') | |
| Constructor setting size. More... | |
| my_basic_string (const std::basic_string< charT > &A, Index pos=0, Index numpos=my_basic_string< charT >::npos) | |
| Construnctor from a basic_string. More... | |
| my_basic_string (const char A[]) | |
| Constructor from a C-style char array. More... | |
| void | insert_substr (const my_basic_string< charT > &searchstr, const my_basic_string< charT > &insstr) |
| Insert string before all occurrences of the substring. More... | |
| void | split (Array< my_basic_string< charT > > &aos, const my_basic_string< charT > &delim) const |
| Split string into substrings. More... | |
| void | toupper () |
| Convert to upper case. More... | |
| my_basic_string | toupper () const |
| void | tolower () |
| Convert to lower case. More... | |
| my_basic_string | tolower () const |
| void | trim () |
| Trim leading and trailing whitespace. More... | |
| Index | nelem () const |
| Number of elements. More... | |
| char | operator[] (Index n) const |
| Constant index operator. More... | |
| char & | operator[] (Index n) |
| Non-constant index operator. More... | |
Static Public Attributes | |
| static const Index | npos = static_cast<Index>(std::basic_string<charT>::npos) |
| Define npos: More... | |
Detailed Description
template<class charT>
class my_basic_string< charT >
The implementation for String, the ARTS string class.
This adds some additional functionality to the standard stl string class, notably:
a) Range checking by assert
b) nelem() member function, return the size of the String of type Index.
The type string is just a typedef for basic_string<char>. Therefore, to make everything work correctly, we have to derive our own class from basic_string, not from string directly.
Definition at line 55 of file mystring.h.
Member Typedef Documentation
◆ size_type
| typedef Index my_basic_string< charT >::size_type |
Definition at line 108 of file mystring.h.
Constructor & Destructor Documentation
◆ my_basic_string() [1/4]
|
default |
◆ my_basic_string() [2/4]
|
inlineexplicit |
Constructor setting size.
You may give as a second argument a character with which to fill the new string. Per default this is zero.
- Parameters
-
n Number of characters c Optional fill character
Definition at line 123 of file mystring.h.
◆ my_basic_string() [3/4]
|
inline |
Construnctor from a basic_string.
This is important for handling of expressions like this to work correctly:
String a = b+'.'+c
As for basic_string, this constructor can also be used to initialize the new string from a subrange of the original string.
- Parameters
-
A The original string pos Start position (0 means from the beginning) numpos How many characters to copy
Definition at line 140 of file mystring.h.
◆ my_basic_string() [4/4]
|
inline |
Constructor from a C-style char array.
Definition at line 174 of file mystring.h.
Member Function Documentation
◆ insert_substr()
|
inline |
Insert string before all occurrences of the substring.
- Parameters
-
[in] searchstr String to search for. [in] insstr String to insert.
Definition at line 184 of file mystring.h.
Referenced by write_method_header_documentation().
◆ nelem()
|
inline |
Number of elements.
Definition at line 246 of file mystring.h.
Referenced by abs_linesChangeBaseParameterForMatchingLevel(), abs_linesChangeBaseParameterForMatchingLines(), abs_linesReplaceParameterWithLinesParameter(), abs_linesSetBaseParameterForMatchingLevel(), abs_linesSetBaseParameterForMatchingLines(), add_basedir(), AgendaExecute(), chk_griddedfield_gridname(), expand_path(), find_file(), ArtsXMLTag::get_attribute_value(), get_dirname(), get_wsv_group_ids(), main(), LineShape::MetaData2ModelShape(), operator<<(), my_basic_string< char >::operator[](), parse_a5_hitran(), ArtsParser::parse_agenda(), parse_f51_hitran(), LineRecord::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat3Stream(), LineRecord::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat4Stream(), LineRecord::ReadFromArtscat5Stream(), Absorption::ReadFromArtscat5Stream(), CIARecord::ReadFromCIA(), LineRecord::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2001Stream(), LineRecord::ReadFromHitran2004Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), LineRecord::ReadFromLBLRTMStream(), Absorption::ReadFromLBLRTMStream(), LineRecord::ReadFromMytran2Stream(), Absorption::ReadFromMytran2Stream(), SpeciesAuxData::ReadFromStream(), QuantumIdentifier::SetFromStringForCO2Band(), SpeciesTag::SpeciesTag(), my_basic_string< char >::split(), my_basic_string< char >::tolower(), my_basic_string< char >::trim(), write_method_header(), and xml_open_output_file().
◆ operator[]() [1/2]
|
inline |
Constant index operator.
We redifine this here so that we can have range checking by assert.
- Parameters
-
[in] n Index
Definition at line 259 of file mystring.h.
Referenced by my_basic_string< char >::tolower().
◆ operator[]() [2/2]
|
inline |
Non-constant index operator.
We redifine this here so that we can have range checking by assert.
- Parameters
-
[in] n Index
Definition at line 272 of file mystring.h.
◆ split()
|
inline |
Split string into substrings.
- Parameters
-
[out] aos ArrayOfString containing the returned substrings. [in] delim Delimiter string.
Definition at line 206 of file mystring.h.
Referenced by get_dirname(), operator>>(), parse_a5_hitran(), parse_atmcompact_scattype(), parse_atmcompact_speciesname(), parse_atmcompact_speciestype(), parse_f51_hitran(), parse_partfield_name(), and ScatSpeciesScatAndMetaRead().
◆ tolower() [1/2]
|
inline |
Convert to lower case.
Definition at line 85 of file mystring.h.
Referenced by time_stepper_selection(), and my_basic_string< char >::tolower().
◆ tolower() [2/2]
|
inline |
Definition at line 89 of file mystring.h.
◆ toupper() [1/2]
|
inline |
Convert to upper case.
Definition at line 74 of file mystring.h.
Referenced by atm_fields_compactFromMatrix(), chk_griddedfield_gridname(), scat_dataCheck(), and my_basic_string< char >::toupper().
◆ toupper() [2/2]
|
inline |
Definition at line 78 of file mystring.h.
◆ trim()
| void my_basic_string< charT >::trim | ( | ) |
Trim leading and trailing whitespace.
Definition at line 225 of file mystring.h.
Referenced by parse_a5_hitran(), parse_f51_hitran(), species_index_from_species_name(), SpeciesTag::SpeciesTag(), and my_basic_string< char >::tolower().
Member Data Documentation
◆ npos
|
static |
Define npos:
Definition at line 106 of file mystring.h.
Referenced by array_species_tag_from_string(), replace_all(), and SpeciesTag::SpeciesTag().
The documentation for this class was generated from the following file:
