debian man page for sosfstring

SoSFString(3)							       Coin							     SoSFString(3)

NAME
       SoSFString -

       The SoSFString class is a container for an SbString.

       This field is used where nodes, engines or other field containers needs to store a single string.

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 needs 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
   SoType SoSFString::getClassTypeId (void) [static]
       Returns a unique type identifier for this field class.

       See also:
	   getTypeId(), SoType

       Reimplemented from SoSField.

   SoType SoSFString::getTypeId (void) const [virtual]
       Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

       See also:
	   getClassTypeId(), SoType

       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.

       Reimplemented from SoSField.

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

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						     SoSFString(3)