AAX SDK  2.1.1
Avid Audio Extensions Development Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Attributes | Protected Attributes | Friends
AAX_CString Class Reference

#include <AAX_CString.h>

Inheritance diagram for AAX_CString:
Inheritance graph
[legend]
Collaboration diagram for AAX_CString:
Collaboration graph
[legend]

Description

A generic AAX string class with similar functionality to std::string.

Public Member Functions

virtual uint32_t Length () const
 
virtual uint32_t MaxLength () const
 
virtual const char * Get () const
 
virtual void Set (const char *iString)
 
virtual AAX_IStringoperator= (const AAX_IString &iOther)
 
virtual AAX_IStringoperator= (const char *iString)
 
 AAX_CString ()
 
 AAX_CString (const char *str)
 
 AAX_CString (const std::string &str)
 
 AAX_CString (const AAX_CString &other)
 
 AAX_CString (const AAX_IString &other)
 
std::string & StdString ()
 
const std::string & StdString () const
 
AAX_CStringoperator= (const AAX_CString &other)
 
AAX_CStringoperator= (const std::string &other)
 
void Clear ()
 
bool Empty () const
 
AAX_CStringErase (uint32_t pos, uint32_t n)
 
AAX_CStringAppend (const AAX_CString &str)
 
AAX_CStringAppend (const char *str)
 
AAX_CStringAppendNumber (double number, int32_t precision)
 
AAX_CStringAppendNumber (int32_t number)
 
AAX_CStringInsert (uint32_t pos, const AAX_CString &str)
 
AAX_CStringInsert (uint32_t pos, const char *str)
 
AAX_CStringInsertNumber (uint32_t pos, double number, int32_t precision)
 
AAX_CStringInsertNumber (uint32_t pos, int32_t number)
 
AAX_CStringReplace (uint32_t pos, uint32_t n, const AAX_CString &str)
 
AAX_CStringReplace (uint32_t pos, uint32_t n, const char *str)
 
uint32_t FindFirst (const AAX_CString &findStr) const
 
uint32_t FindFirst (const char *findStr) const
 
uint32_t FindFirst (char findChar) const
 
uint32_t FindLast (const AAX_CString &findStr) const
 
uint32_t FindLast (const char *findStr) const
 
uint32_t FindLast (char findChar) const
 
const char * CString () const
 
bool ToDouble (double *oValue) const
 
bool ToInteger (int32_t *oValue) const
 
void SubString (uint32_t pos, uint32_t n, AAX_IString *outputStr) const
 
bool operator== (const AAX_CString &other) const
 
bool operator== (const char *otherStr) const
 
bool operator== (const std::string &otherStr) const
 
bool operator!= (const AAX_CString &other) const
 
bool operator!= (const char *otherStr) const
 
bool operator!= (const std::string &otherStr) const
 
bool operator< (const AAX_CString &other) const
 
bool operator> (const AAX_CString &other) const
 
const char & operator[] (uint32_t index) const
 
char & operator[] (uint32_t index)
 
AAX_CStringoperator+= (const AAX_CString &str)
 
AAX_CStringoperator+= (const char *str)
 
- Public Member Functions inherited from AAX_IString
virtual ~AAX_IString ()
 

Static Public Attributes

static const uint32_t kInvalidIndex = static_cast<uint32_t>(-1)
 
static const uint32_t kMaxStringLength = static_cast<uint32_t>(-2)
 

Protected Attributes

std::string mString
 

Friends

std::ostream & operator<< (std::ostream &os, const AAX_CString &str)
 
std::istream & operator>> (std::istream &os, AAX_CString &str)
 

Constructor & Destructor Documentation

AAX_CString::AAX_CString ( )

Constructs an empty string.

AAX_CString::AAX_CString ( const char *  str)

Implicit conversion constructor: Constructs a string with a const char* pointer to copy.

AAX_CString::AAX_CString ( const std::string &  str)
explicit

Copy constructor: Constructs a string from a std::string. Beware of STL variations across various binaries.

AAX_CString::AAX_CString ( const AAX_CString other)

Copy constructor: Constructs a string with another concrete AAX_CString.

AAX_CString::AAX_CString ( const AAX_IString other)

Copy constructor: Constructs a string from another string that meets the AAX_IString interface.

Member Function Documentation

virtual uint32_t AAX_CString::Length ( ) const
virtual
virtual uint32_t AAX_CString::MaxLength ( ) const
virtual

Implements AAX_IString.

virtual const char* AAX_CString::Get ( ) const
virtual

C string methods

Implements AAX_IString.

virtual void AAX_CString::Set ( const char *  iString)
virtual

Implements AAX_IString.

virtual AAX_IString& AAX_CString::operator= ( const AAX_IString iOther)
virtual

Assignment operators

Implements AAX_IString.

virtual AAX_IString& AAX_CString::operator= ( const char *  iString)
virtual

Implements AAX_IString.

std::string& AAX_CString::StdString ( )

Direct access to a std::string.

const std::string& AAX_CString::StdString ( ) const

Direct access to a const std::string.

AAX_CString& AAX_CString::operator= ( const AAX_CString other)

Assignment operator from another AAX_CString. This is kind of required or the compiler will make one for us.

AAX_CString& AAX_CString::operator= ( const std::string &  other)

Assignment operator from a std::string. Beware of STL variations across various binaries.

void AAX_CString::Clear ( )

Referenced by AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >::ValueToString().

Here is the caller graph for this function:

bool AAX_CString::Empty ( ) const
AAX_CString& AAX_CString::Erase ( uint32_t  pos,
uint32_t  n 
)
AAX_CString& AAX_CString::Append ( const AAX_CString str)
AAX_CString& AAX_CString::Append ( const char *  str)
AAX_CString& AAX_CString::AppendNumber ( double  number,
int32_t  precision 
)

Referenced by AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >::ValueToString().

Here is the caller graph for this function:

AAX_CString& AAX_CString::AppendNumber ( int32_t  number)
AAX_CString& AAX_CString::Insert ( uint32_t  pos,
const AAX_CString str 
)
AAX_CString& AAX_CString::Insert ( uint32_t  pos,
const char *  str 
)
AAX_CString& AAX_CString::InsertNumber ( uint32_t  pos,
double  number,
int32_t  precision 
)
AAX_CString& AAX_CString::InsertNumber ( uint32_t  pos,
int32_t  number 
)
AAX_CString& AAX_CString::Replace ( uint32_t  pos,
uint32_t  n,
const AAX_CString str 
)
AAX_CString& AAX_CString::Replace ( uint32_t  pos,
uint32_t  n,
const char *  str 
)
uint32_t AAX_CString::FindFirst ( const AAX_CString findStr) const
uint32_t AAX_CString::FindFirst ( const char *  findStr) const
uint32_t AAX_CString::FindFirst ( char  findChar) const
uint32_t AAX_CString::FindLast ( const AAX_CString findStr) const
uint32_t AAX_CString::FindLast ( const char *  findStr) const
uint32_t AAX_CString::FindLast ( char  findChar) const
const char* AAX_CString::CString ( ) const
bool AAX_CString::ToDouble ( double *  oValue) const

Referenced by AAX_CNumberDisplayDelegate< T, Precision, SpaceAfter >::StringToValue().

Here is the caller graph for this function:

bool AAX_CString::ToInteger ( int32_t *  oValue) const
void AAX_CString::SubString ( uint32_t  pos,
uint32_t  n,
AAX_IString outputStr 
) const
bool AAX_CString::operator== ( const AAX_CString other) const
bool AAX_CString::operator== ( const char *  otherStr) const
bool AAX_CString::operator== ( const std::string &  otherStr) const
bool AAX_CString::operator!= ( const AAX_CString other) const
bool AAX_CString::operator!= ( const char *  otherStr) const
bool AAX_CString::operator!= ( const std::string &  otherStr) const
bool AAX_CString::operator< ( const AAX_CString other) const
bool AAX_CString::operator> ( const AAX_CString other) const
const char& AAX_CString::operator[] ( uint32_t  index) const
char& AAX_CString::operator[] ( uint32_t  index)
AAX_CString& AAX_CString::operator+= ( const AAX_CString str)
AAX_CString& AAX_CString::operator+= ( const char *  str)

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const AAX_CString str 
)
friend

output stream operator for concrete AAX_CString

std::istream& operator>> ( std::istream &  os,
AAX_CString str 
)
friend

input stream operator for concrete AAX_CString

Member Data Documentation

const uint32_t AAX_CString::kInvalidIndex = static_cast<uint32_t>(-1)
static
const uint32_t AAX_CString::kMaxStringLength = static_cast<uint32_t>(-2)
static
std::string AAX_CString::mString
protected

The documentation for this class was generated from the following file: