FIXEDSTRING< _CT > Class Template Reference

Fixed-size array-based MIUNICODE string. More...

#include <mi32/fixedstr.h>

Inheritance diagram for FIXEDSTRING< _CT >:

Inheritance graph
FIXEDSTRING\< 128 \>FIXEDSTRING\< SPECTRUM_HISTORY_SIZE \>FIXEDSTRING\< SPECTRUM_USERNAME_SIZE \>FIXEDSTRING\< 80 \>FIXEDSTRING\< 256 \>FIXEDSTRING\< SPECTRUM_TITLE_SIZE \>
[legend]
List of all members.

Public Member Functions

void Append (const char *name)
void Assign (const MIUNICODE *name, int len)
void Assign (const char *name, CHAR_ENCODING encoding)
void Assign (const char *name, int len)
void Assign (const char *name)
void Clear ()
int Compare (const MIUNICODE *str) const
int Compare (const FIXEDSTRING &str) const
int CompareNoCase (const MIUNICODE *str) const
int CompareNoCase (const FIXEDSTRING &str) const
 FIXEDSTRING (TEXTID textid)
 FIXEDSTRING (const MISTRING &string)
 FIXEDSTRING (const MIUNICODE *string)
template<int _T2>
 FIXEDSTRING (const FIXEDSTRING< _T2 > &rhs)
 FIXEDSTRING (const FIXEDSTRING &rhs)
 FIXEDSTRING ()
ERRVALUE GenerateUniqueName (UNIQUENAMEFILTER &FilterInst)
ERRVALUE GenerateUniqueName (FastDelegate< int(const FIXEDSTRING< _CT > &)> delegate)
void * GetEncoded (CHAR_ENCODING encoding) const
int GetLength () const
const MIUNICODE * GetReference () const
const MIUNICODE * GetTail (int maxlen) const
bool IniRead (INIHANDLE inih, const char *group, const char *const field)
void IniWrite (INIHANDLE inih, const char *group, const char *const field) const
bool IsEmpty () const
bool IsValidName (FastDelegate< bool(MIUNICODE)> delegate=FastDelegate< bool(MIUNICODE)>(DftValidNameChar)) const
void MakeValidName (FastDelegate< bool(MIUNICODE)> delegate=FastDelegate< bool(MIUNICODE)>(DftValidNameChar))
 operator const MIUNICODE * () const
bool operator!= (const MIUNICODE *rhs) const
bool operator!= (const FIXEDSTRING &rhs) const
FIXEDSTRING & operator+= (const MIUNICODE *rhs)
template<int _T2>
FIXEDSTRING< _CT > & operator+= (const FIXEDSTRING< _T2 > &rhs)
bool operator< (const MIUNICODE *rhs) const
bool operator< (const FIXEDSTRING &rhs) const
bool operator<= (const MIUNICODE *rhs) const
bool operator<= (const FIXEDSTRING &rhs) const
FIXEDSTRING & operator= (TEXTID textid)
FIXEDSTRING & operator= (const MISTRING &rhs)
FIXEDSTRING & operator= (const MIUNICODE *rhs)
template<int _T2>
FIXEDSTRING< _CT > & operator= (const FIXEDSTRING< _T2 > &rhs)
FIXEDSTRING & operator= (const FIXEDSTRING &rhs)
bool operator== (const MIUNICODE *rhs) const
bool operator== (const FIXEDSTRING &rhs) const
bool operator> (const MIUNICODE *rhs) const
bool operator> (const FIXEDSTRING &rhs) const
bool operator>= (const MIUNICODE *rhs) const
bool operator>= (const FIXEDSTRING &rhs) const
void PadToEnd (char item)
void SetLowerCase ()
void SetUpperCase ()
void SwapBytes ()
void Terminate ()
void Truncate (int NewLength)
 ~FIXEDSTRING ()

Static Public Member Functions

static int GetMaxSize ()

Classes

class  UNIQUENAMEFILTER
 Unique name filter class to determine if the name given is unique. More...

Detailed Description

template<int _CT>
class FIXEDSTRING< _CT >

Fixed-size array-based MIUNICODE string.

This class is designed to replace fixed size MIUNICODE array string constructs in other classes and structures. It is not meant as a STRING class implementation. Therefore, the class cannot have virtual methods nor any other members except for the string storage itself.

Definition at line 190 of file fixedstr.h.

Constructor & Destructor Documentation

template<int _CT>
FIXEDSTRING< _CT >::FIXEDSTRING (  )  [inline]

Default constructor, clears the string.

Definition at line 194 of file fixedstr.h.

template<int _CT>
FIXEDSTRING< _CT >::FIXEDSTRING ( const FIXEDSTRING< _CT > &  rhs  )  [inline]

Copy constructor.

Definition at line 198 of file fixedstr.h.

template<int _CT>
template<int _T2>
FIXEDSTRING< _CT >::FIXEDSTRING ( const FIXEDSTRING< _T2 > &  rhs  )  [inline]

Copy constructor.

Parameters:
rhs  String to concatinate from

Definition at line 204 of file fixedstr.h.

template<int _CT>
FIXEDSTRING< _CT >::FIXEDSTRING ( const MIUNICODE *  string  )  [inline]

Construct from MIUNICODE string.

Definition at line 212 of file fixedstr.h.

template<int _CT>
FIXEDSTRING< _CT >::FIXEDSTRING ( const MISTRING &  string  )  [inline]

Construct from MISTRING string.

Definition at line 220 of file fixedstr.h.

template<int _CT>
FIXEDSTRING< _CT >::FIXEDSTRING ( TEXTID  textid  )  [inline]

Construct from TEXTID.

Definition at line 228 of file fixedstr.h.

template<int _CT>
FIXEDSTRING< _CT >::~FIXEDSTRING (  )  [inline]

Destructor.

Definition at line 233 of file fixedstr.h.

Member Function Documentation

template<int _CT>
void FIXEDSTRING< _CT >::Append ( const char *  name  )  [inline]

Append from character string, not a constructor so that it is locatable in code.

Parameters:
name  Character string to append from

Definition at line 367 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Assign ( const MIUNICODE *  name,
int  len 
) [inline]

Assign from MIUNICODE string with a max length given.

Parameters:
name  MIUNICODE string to assign from

Definition at line 402 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Assign ( const char *  name,
CHAR_ENCODING  encoding 
) [inline]

Assign from character string, not a constructor so that it is locatable in code.

Parameters:
name  Character string to assign from
encoding  Encoding to use

Definition at line 387 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Assign ( const char *  name,
int  len 
) [inline]

Assign from character string, not a constructor so that it is locatable in code.

Parameters:
name  Character string to assign from

Definition at line 381 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Assign ( const char *  name  )  [inline]

Assign from character string, not a constructor so that it is locatable in code.

Parameters:
name  Character string to assign from

Definition at line 376 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Clear (  )  [inline]

Clear the whole string.

Definition at line 408 of file fixedstr.h.

template<int _CT>
int FIXEDSTRING< _CT >::Compare ( const MIUNICODE *  str  )  const [inline]

Case-sensitive comparison, length limited (similar to strncmp).

Returns:
0 if strings equal, -1 if this < str, 1 if this > str.
Parameters:
str  String to compare to

Definition at line 419 of file fixedstr.h.

template<int _CT>
int FIXEDSTRING< _CT >::Compare ( const FIXEDSTRING< _CT > &  str  )  const [inline]

Case-sensitive comparison, length limited (similar to strncmp).

Returns:
0 if strings equal, -1 if this < str, 1 if this > str.
Parameters:
str  String to compare to

Definition at line 413 of file fixedstr.h.

template<int _CT>
int FIXEDSTRING< _CT >::CompareNoCase ( const MIUNICODE *  str  )  const [inline]

Case-insensitive comparison (similar to stricmp).

Returns:
0 if strings equal, -1 if this < str, 1 if this > str.
Parameters:
str  String to compare to

Definition at line 431 of file fixedstr.h.

template<int _CT>
int FIXEDSTRING< _CT >::CompareNoCase ( const FIXEDSTRING< _CT > &  str  )  const [inline]

Case-insensitive comparison (similar to stricmp).

Returns:
0 if strings equal, -1 if this < str, 1 if this > str.
Parameters:
str  String to compare to

Definition at line 425 of file fixedstr.h.

template<int _CT>
ERRVALUE FIXEDSTRING< _CT >::GenerateUniqueName ( UNIQUENAMEFILTER &  FilterInst  )  [inline]

Generate an unique name based on the filter passed in.

Definition at line 498 of file fixedstr.h.

template<int _CT>
ERRVALUE FIXEDSTRING< _CT >::GenerateUniqueName ( FastDelegate< int(const FIXEDSTRING< _CT > &)>  delegate  )  [inline]

Generate an unique name based on the filter passed in.

String is already unique

Initialize string and pointer for character replacement

Make sure rest of m_String is set to 0

Reset system and increment where

Reality check, if need to increase, it can be. 37 ^ 4 tried!

As far out a possible, retreat until a match is not found

Out of 37 ^ (_CT-1) possible combinations, none found

Definition at line 448 of file fixedstr.h.

template<int _CT>
void* FIXEDSTRING< _CT >::GetEncoded ( CHAR_ENCODING  encoding  )  const [inline]

Get string in specified encoding.

Returns:
Encoded string caller must free.
Parameters:
encoding  Encoding

Definition at line 507 of file fixedstr.h.

template<int _CT>
int FIXEDSTRING< _CT >::GetLength (  )  const [inline]

Return length of string, not including terminator.

Definition at line 515 of file fixedstr.h.

template<int _CT>
static int FIXEDSTRING< _CT >::GetMaxSize (  )  [inline, static]

Return maximum string size, not including terminator.

Definition at line 519 of file fixedstr.h.

template<int _CT>
const MIUNICODE* FIXEDSTRING< _CT >::GetReference (  )  const [inline]

Return const string pointer, used for sprintf type parameters.

Definition at line 523 of file fixedstr.h.

template<int _CT>
const MIUNICODE* FIXEDSTRING< _CT >::GetTail ( int  maxlen  )  const [inline]

Get tail of string having up to specified number of characters.

Definition at line 527 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::IniRead ( INIHANDLE  inih,
const char *  group,
const char *const  field 
) [inline]

Set the string according to values in ini file.

Returns:
: 'true' if entry found and information read, false if empty field or field does not exist

Definition at line 537 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::IniWrite ( INIHANDLE  inih,
const char *  group,
const char *const  field 
) const [inline]

Save the string to values in ini file.

Definition at line 544 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::IsEmpty (  )  const [inline]

Find out if the string is empty.

Definition at line 532 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::IsValidName ( FastDelegate< bool(MIUNICODE)>  delegate = FastDelegate<bool(MIUNICODE)>(DftValidNameChar)  )  const [inline]

Definition at line 550 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::MakeValidName ( FastDelegate< bool(MIUNICODE)>  delegate = FastDelegate<bool(MIUNICODE)>(DftValidNameChar)  )  [inline]

Definition at line 562 of file fixedstr.h.

template<int _CT>
FIXEDSTRING< _CT >::operator const MIUNICODE * (  )  const [inline]

Cast to <const MIUNICODE*>.

Definition at line 359 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator!= ( const MIUNICODE *  rhs  )  const [inline]

Inequality.

Definition at line 314 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator!= ( const FIXEDSTRING< _CT > &  rhs  )  const [inline]

Inequality.

Definition at line 309 of file fixedstr.h.

template<int _CT>
FIXEDSTRING& FIXEDSTRING< _CT >::operator+= ( const MIUNICODE *  rhs  )  [inline]

Concatenate from MIUNICODE string.

Parameters:
rhs  String to concatinate from

Definition at line 291 of file fixedstr.h.

template<int _CT>
template<int _T2>
FIXEDSTRING<_CT>& FIXEDSTRING< _CT >::operator+= ( const FIXEDSTRING< _T2 > &  rhs  )  [inline]

Concatenate operator.

Parameters:
rhs  String to concatinate from

Definition at line 283 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator< ( const MIUNICODE *  rhs  )  const [inline]

Less Than.

Definition at line 324 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator< ( const FIXEDSTRING< _CT > &  rhs  )  const [inline]

Less Than.

Definition at line 319 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator<= ( const MIUNICODE *  rhs  )  const [inline]

Less Than or Equal to.

Definition at line 334 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator<= ( const FIXEDSTRING< _CT > &  rhs  )  const [inline]

Less Than or Equal to.

Definition at line 329 of file fixedstr.h.

template<int _CT>
FIXEDSTRING& FIXEDSTRING< _CT >::operator= ( TEXTID  textid  )  [inline]

Assign from TEXTID.

Parameters:
textid  Message text ID

Definition at line 277 of file fixedstr.h.

template<int _CT>
FIXEDSTRING& FIXEDSTRING< _CT >::operator= ( const MISTRING &  rhs  )  [inline]

Assign from MISTRING string.

Parameters:
rhs  String to assign from

Definition at line 268 of file fixedstr.h.

template<int _CT>
FIXEDSTRING& FIXEDSTRING< _CT >::operator= ( const MIUNICODE *  rhs  )  [inline]

Assign from MIUNICODE string.

Parameters:
rhs  String to assign from

Definition at line 257 of file fixedstr.h.

template<int _CT>
template<int _T2>
FIXEDSTRING<_CT>& FIXEDSTRING< _CT >::operator= ( const FIXEDSTRING< _T2 > &  rhs  )  [inline]

Assignment operator.

Parameters:
rhs  String to concatinate from

Definition at line 248 of file fixedstr.h.

template<int _CT>
FIXEDSTRING& FIXEDSTRING< _CT >::operator= ( const FIXEDSTRING< _CT > &  rhs  )  [inline]

Assignment operator.

Parameters:
rhs  String to assign from

Definition at line 237 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator== ( const MIUNICODE *  rhs  )  const [inline]

Equality.

Definition at line 304 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator== ( const FIXEDSTRING< _CT > &  rhs  )  const [inline]

Equality.

Definition at line 299 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator> ( const MIUNICODE *  rhs  )  const [inline]

Greater Than.

Definition at line 344 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator> ( const FIXEDSTRING< _CT > &  rhs  )  const [inline]

Greater Than.

Definition at line 339 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator>= ( const MIUNICODE *  rhs  )  const [inline]

Greater Than or Equal to.

Definition at line 354 of file fixedstr.h.

template<int _CT>
bool FIXEDSTRING< _CT >::operator>= ( const FIXEDSTRING< _CT > &  rhs  )  const [inline]

Greater Than or Equal to.

Definition at line 349 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::PadToEnd ( char  item  )  [inline]

Pad the string with a char to the end of the buffer.

Definition at line 591 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::SetLowerCase (  )  [inline]

Set the string to lower case letters.

Definition at line 599 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::SetUpperCase (  )  [inline]

Set the string to upper case letters.

Definition at line 603 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::SwapBytes (  )  [inline]

Swap bytes of the string, used for RVC strings.

Definition at line 607 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Terminate (  )  [inline]

Force termination of string at the end.

Definition at line 611 of file fixedstr.h.

template<int _CT>
void FIXEDSTRING< _CT >::Truncate ( int  NewLength  )  [inline]

Truncate the string, has no effect if the string is shorter than NewLength.

Definition at line 615 of file fixedstr.h.

The documentation for this class was generated from the following file:
Generated on Thu Apr 26 04:47:07 2007 for TNTsdk by  doxygen 1.5.2