Sitemap | Search || Zen Spider Website / Satori / Satori Class Index / Class String

Class String

1. 	class String
   	Programmer: Ryan Davis

3. 1. Description:

5. 1. Define a "plug & play" string class in order to catch any and all improper // use of a string type such as non terminated strings, range checking, etc.

1. 3. 1. Public Methods:

   5. 1. 4. 1. String
         6. (const char * aString = "");
         8. I am the default and standard constructor for string. I
2. have a default value of "" so that I may be used with arrays
3. and other situations needing it. I create a copy of the
4. string passed to me.
5. CAUTION: I will bomb if aString is a NULL pointer.
6. 1. 
      
   2. 
      
   6. 1. String
   8. (const char * aString, const UInteger & aSize);
   10. I am a conversion constructor. I am used in the case of
7. not having a NULL terminated string or when you have the
8. need to pull out a substring of known size.
9. CAUTION: I will bomb if aString is a NULL pointer.
10. 1. 
       
    2. 
       
    6. 1. String
    8. (const String & aString);
    10. I am the copy constructor. I will create a copy of the
11. string object passed to me.
12. 1. 
       
    2. 
       
    6. 1. ~String
    8. ();
    10. I am the destructor. I deallocate the memory used and
13. sets everything back to a safe state.
14. 1. 
       
    2. 
       
    5. String &
    6. 1. operator =
    8. (const char * aString);
    10. I am a conversion = operator. It will copy a low level
15. string's contents into the current string, deleting the
16. current contents if necessary.
17. CAUTION: I will bomb if aString is a NULL pointer.
18. 1. 
       
    2. 
       
    5. String &
    6. 1. operator =
    8. (const String & aString);
    10. I am the standard operator =(). I will create a copy
19. of aString, deleting my current contents if necessary.
20. 1. 
       
    2. 
       
    5. char *
    6. 1. asCString
    8. ();
    10. I am an explicit conversion constructor. I am used when you
21. absolutely have to use me as a char *.
22. 1. 
       
    2. 
       
    5. char &
    6. 1. operator[]
    8. (const UInteger & index);
    10. I am the subindexing operator. I will allow you to
23. access my individual characters by their array index.
24. As always C/++ arrays are zero based.
25. CAUTION: I will bomb if index > mySize
26. 1. 
       
    2. 
       
    5. UInteger
    6. 1. length
    8. ();
    11. 
        
    12. 
        
    15. Boolean operator
    16. 1. <
    18. (const String & aString);
    21. 
        
    22. 
        
    25. Boolean operator
    26. 1. >
    28. (const String & aString);
    31. 
        
    32. 
        
    35. Boolean operator
    36. 1. <=
    38. (const String & aString);
    41. 
        
    42. 
        
    45. Boolean operator
    46. 1. >=
    48. (const String & aString);
    51. 
        
    52. 
        
    55. Boolean operator
    56. 1. =
    58. (const String & aString);
    61. 
        
    62. 
        
    65. Boolean operator
    66. 1. !=
    68. (const String & aString);
    71. 
        
    72. 
        
    75. String &
    76. 1. operator +=
    78. (const String & aString);
    81. 
        
    82. 
        
    85. String operator
    87. (const String & aString);
    89. services
27. I am an internal utility used by the default constructor
28. and assignment operator. I do all the work of copying a
29. low level string. I was created for safety and maintenance
30. reasons.
31. CAUTION: I will bomb if aString is NULL _OR_ if aString == myString
32. data
33. 1. 
       
    2. 
       
    3. 1. Protected Methods:

    7. 1. Protected Members:

    9. 1. 3. 
             
          4. UInteger
          5. 1. mySize;
          9. 
             
          10. 
              
          13. 
              
          14. char *
          15. 1. myString;
          19. 
              
          20. 
              

Sitemap | Search || Zen Spider Website / Satori / Satori Class Index / Class String