SoSFString(3)

NAME
SoSFString - The SoSFString class is a container for an SbString.

SYNOPSIS

#include <Inventor/fields/SoSFString.h>

Inherits SoSField.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFString & operator= (const SoSFString &field)
virtual SbBool isSame (const SoField &field) const
const SbString & getValue (void) const
void setValue (const SbString &newvalue)
const SbString & operator= (const SbString &newvalue)
int operator== (const SoSFString &field) const
int operator!= (const SoSFString &field) const
void setValue (const char *str)

  Static Public Member Functions
static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

  Protected Attributes
SbString value

  Additional Inherited Members

Detailed Description

The SoSFString class is a container for an SbString. This field is used where nodes, engines or other field containers need to store a single string.

Fields of this type stores their value to file as a the string within quotes.

See also
    SoMFString

Member Function Documentation

  void * SoSFString::createInstance (void) [static]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
 Creates a new instance of the class type corresponding to the SoType object.

  SoType SoSFString::getClassTypeId (void) [static]
This static method returns the SoType object associated with objects of this class.

  SoType SoSFString::getTypeId (void) const [virtual]
Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and 'downward' casting.

Implements SoField.

  void SoSFString::copyFrom (const SoField & f) [virtual]
Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

  SbBool SoSFString::isSame (const SoField & f) const [virtual]
Check for equal type and value(s).

Implements SoField.

  void SoSFString::initClass (void) [static]
Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

  void SoSFString::setValue (const char * str)
Set string field value from str.

Author

Generated automatically by Doxygen for Coin from the source code.