Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

SbName Class Reference
[Base classes]

The SbName class stores strings by reference in a hash table. More...

#include <Inventor/SbName.h>

List of all members.

Public Member Functions

 SbName (void)
 SbName (const char *nameString)
 SbName (const SbString &str)
 SbName (const SbName &name)
 ~SbName (void)
const char * getString (void) const
int getLength (void) const
int operator! (void) const
 operator const char * (void) const

Static Public Member Functions

SbBool isIdentStartChar (const char c)
SbBool isIdentChar (const char c)
SbBool isBaseNameStartChar (const char c)
SbBool isBaseNameChar (const char c)

Friends

int operator== (const SbName &lhs, const char *rhs)
int operator== (const char *lhs, const SbName &rhs)
int operator== (const SbName &lhs, const SbName &rhs)
int operator!= (const SbName &lhs, const char *rhs)
int operator!= (const char *lhs, const SbName &rhs)
int operator!= (const SbName &lhs, const SbName &rhs)


Detailed Description

The SbName class stores strings by reference in a hash table.

The class is used by inventor for keywords and other unique names that are used all over the place and would waste tons of memory if they were duplicated for each reference. Because strings are uniquely identified by their reference, string comparisons for SbName objects are very efficient.


Constructor & Destructor Documentation

SbName::SbName void   ) 
 

This is the default constructor.

SbName::SbName const char *  nameString  ) 
 

Constructor. Adds the nameString string to the name table.

SbName::SbName const SbString str  ) 
 

Constructor. Adds str to the name table.

SbName::SbName const SbName name  ) 
 

Copy constructor.

SbName::~SbName void   ) 
 

The destructor.


Member Function Documentation

const char * SbName::getString void   )  const
 

This method returns pointer to character array for the name.

int SbName::getLength void   )  const
 

This method returns the number of characters in the name.

SbBool SbName::isIdentStartChar const char  c  )  [static]
 

This method checks if the c character is a valid identifier start character for a name.

See also:
SbBool SbName::isIdentChar(const char c)

SbBool SbName::isIdentChar const char  c  )  [static]
 

This method checks if the c character is a valid character for a name.

See also:
SbBool SbName::isIdentStartChar(const char c)

SbBool SbName::isBaseNameStartChar const char  c  )  [static]
 

Returns TRUE if the given character is valid for use as the first character of a name for an object derived from a class inheriting SoBase.

SoBase derived objects needs to be named in a manner which will not clash with the special characters reserved as tokens in the syntax rules of Open Inventor and VRML files.

This method is not part of the original Open Inventor API.

See also:
isBaseNameChar()

SbBool SbName::isBaseNameChar const char  c  )  [static]
 

Returns TRUE if the given character is valid for use in naming object instances of classes derived from SoBase.

SoBase derived objects needs to be named in a manner which will not clash with the special characters reserved as tokens in the syntax rules of Open Inventor and VRML files.

This method is not part of the original Open Inventor API.

See also:
isBaseNameStartChar()

int SbName::operator! void   )  const
 

This unary operator results in FALSE if the SbName object is non-empty and TRUE if the SbName object is empty. An empty name contains a null-length string.

SbName::operator const char * void   )  const
 

This operator returns a pointer to the character array for the name string. It is intended for implicit use. Use SbName::getString() explicitly instead of this operator - it might be removed later.

See also:
const char * SbName::getString(void)


Friends And Related Function Documentation

int operator== const SbName lhs,
const char *  rhs
[friend]
 

This operator checks for equality and returns TRUE if so, and FALSE otherwise.

int operator== const char *  lhs,
const SbName rhs
[friend]
 

This operator checks for equality and returns TRUE if so, and FALSE otherwise.

int operator== const SbName lhs,
const SbName rhs
[friend]
 

This operator checks for equality and returns TRUE if so, and FALSE otherwise.

int operator!= const SbName lhs,
const char *  rhs
[friend]
 

This operator checks for inequality and returns TRUE if so, and FALSE if the names are equal.

int operator!= const char *  lhs,
const SbName rhs
[friend]
 

This operator checks for inequality and returns TRUE if so, and FALSE if the names are equal.

int operator!= const SbName lhs,
const SbName rhs
[friend]
 

This operator checks for inequality and returns TRUE if so, and FALSE if the names are equal.


The documentation for this class was generated from the following files:
Generated on Tue Jul 27 23:53:06 2004 for Coin by doxygen 1.3.7