---

osg::MField< FieldTypeT, fieldNameSpace > Class Template Reference
[FieldLib, MultiFields]

Base class for all multi field, for example MFMatrix. More...

#include <OSGMField.h>

Inheritance diagram for osg::MField< FieldTypeT, fieldNameSpace >:

[legend]Collaboration diagram for osg::MField< FieldTypeT, fieldNameSpace >:

[legend]List of all members.

Public Types
typedef MFieldVector< FieldTypeT >	StorageType
	Storage type.
typedef StorageType::iterator	iterator
	Storage iterator.
typedef StorageType::const_iterator	const_iterator
	Const Storage iterator.
typedef StorageType::reference	reference
	Value reference.
typedef StorageType::const_reference	const_reference
	Const value reference.
typedef osgIF< fieldNameSpace==1, FieldDataTraits1< FieldTypeT >, FieldDataTraits2< FieldTypeT > >::_IRet	MF1Trait
typedef osgIF< fieldNameSpace==0, FieldDataTraits< FieldTypeT >, MF1Trait >::_IRet	MFieldTraits
typedef MField< FieldTypeT, fieldNameSpace >	Self
typedef FieldTypeT	StoredType
typedef MFieldTraits::ArgumentType	ArgumentType
Public Methods
Constructors
	MField (void)
	MField (const MField &obj)
	MField (const UInt32 size)
Destructor
virtual	~MField (void)
Get
reference	getValue (const UInt32 index)
const_reference	getValue (const UInt32 index) const
virtual UInt32	getSize (void) const
	Returns the size of the field, allway 1 for single fields.
StorageType &	getValues (void)
	Return a reference to the value store.
const StorageType &	getValues (void) const
	Return a const reference to the value store.
virtual const FieldType &	getType (void) const
	Returns the type of the field.
virtual bool	isEmpty (void) const
	Returns the type of the field.
Set
virtual void	setAbstrValue (const Field &obj)
	Copies the values from a given field iff the two fieldtypes are the same.
void	setValues (const StorageType &value)
	Copies the values from a given value store.
void	setValues (const Self &obj)
	Copies the values from a given field.
void	setValue (ArgumentType value, const UInt32 index)
	Copies the values from a given field iff the two fieldtypes are the same.
void	addValue (ArgumentType value)
	Copies the values from a given field iff the two fieldtypes are the same.
STL Interface
iterator	begin (void)
	Return an iterator to the first element.
iterator	end (void)
	Return an iterator to the end of the store.
const_iterator	begin (void) const
	Return a const iterator to the first element.
const_iterator	end (void) const
	Return a const iterator to the end of the store.
reference	front (void)
	Returns an interator to the first element.
const_reference	front (void) const
	Returns a const interator to the first element.
reference	back (void)
	Returns an interator to the last element.
const_reference	back (void) const
	Returns a const interator to the last element.
void	clear (void)
	Clears the value store.
iterator	insert (iterator pos, ArgumentType value)
	Inserts value at the given pos.
iterator	erase (iterator pos)
	Removes values from the given pos.
iterator	find (ArgumentType value)
	Returns an iterator to the given value if found otherwise end().
const_iterator	find (ArgumentType value) const
	Returns a const iterator to the given value if found otherwise end().
void	push_back (ArgumentType value)
	push back value
void	resize (size_t newsize, FieldTypeT t=FieldTypeT())
	resizes the container to given size. Depends on the underlying stll container implementation
void	reserve (size_t newsize)
	allocates memory for the given number of elements. Depends on the underlying stl container implementation
UInt32	size (void) const
	Returns the size of the field.
bool	empty (void) const
	Returns true if the field does not hold any value.
Index Operator
reference	operator[] (UInt32 index)
	Returns a reference to the value at the given index.
const_reference	operator[] (UInt32 index) const
	Returns a const reference to the value at the given index.
Assignment
void	operator= (const MField &source)
String IO
virtual void	pushValueByStr (const Char8 *str)
	Sets the field value from a given string.
virtual string &	getValueByStr (string &str) const
	Dump the field to a given string.
virtual string &	getValueByStr (string &str, StringConversionStateBase &state) const
	Sets the field value from a given string.
MT Sync
void	syncWith (Self &source)
Binary Interface
UInt32	getBinSize (void)
void	copyToBin (BinaryDataHandler &pMem)
void	copyFromBin (BinaryDataHandler &pMem)
Dump
virtual void	dump (void) const
	Dump property contents to stderr, should be changed to use a log stream instead.
Static Public Methods
Class Get
const FieldType &	getClassType (void)
Protected Types
typedef Field	Inherited
	Parent type.
Static Protected Methods
Field *	create (void)
	Create method used by the factory to create an instance.
Protected Attributes
StorageType	_values
	Value store.
Static Protected Attributes
const FieldType	_fieldType
Friends
class	FieldContainer

---

Detailed Description

template<class FieldTypeT, Int32 fieldNameSpace = 0>
class osg::MField< FieldTypeT, fieldNameSpace >

Base class for all multi field, for example MFMatrix.

---

Member Typedef Documentation

template<class FieldTypeT, Int32 fieldNameSpace = 0> vector< FieldTypeT > osg::MField< FieldTypeT, fieldNameSpace >::StorageType

Storage type.

template<class FieldTypeT, Int32 fieldNameSpace = 0> vector< FieldTypeT >::iterator osg::MField< FieldTypeT, fieldNameSpace >::iterator

Storage iterator.

template<class FieldTypeT, Int32 fieldNameSpace = 0> vector< FieldTypeT >::const_iterator osg::MField< FieldTypeT, fieldNameSpace >::const_iterator

Const Storage iterator.

template<class FieldTypeT, Int32 fieldNameSpace = 0> vector< FieldTypeT >::reference osg::MField< FieldTypeT, fieldNameSpace >::reference

Value reference.

template<class FieldTypeT, Int32 fieldNameSpace = 0> vector< FieldTypeT >::const_reference osg::MField< FieldTypeT, fieldNameSpace >::const_reference

Const value reference.

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef osgIF<fieldNameSpace == 1, FieldDataTraits1<FieldTypeT>, FieldDataTraits2<FieldTypeT> >::_IRet osg::MField< FieldTypeT, fieldNameSpace >::MF1Trait

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef osgIF<fieldNameSpace == 0, FieldDataTraits <FieldTypeT>, MF1Trait>::_IRet osg::MField< FieldTypeT, fieldNameSpace >::MFieldTraits

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef MField<FieldTypeT, fieldNameSpace> osg::MField< FieldTypeT, fieldNameSpace >::Self

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef FieldTypeT osg::MField< FieldTypeT, fieldNameSpace >::StoredType

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef MFieldTraits::ArgumentType osg::MField< FieldTypeT, fieldNameSpace >::ArgumentType

template<class FieldTypeT, Int32 fieldNameSpace = 0> osg::MField< FieldTypeT, fieldNameSpace >::Inherited [protected]

Parent type.

---

Constructor & Destructor Documentation

template<class FieldTypeT, Int32 fieldNameSpace> osg::MField< FieldTypeT, fieldNameSpace >::MField (  void    )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> osg::MField< FieldTypeT, fieldNameSpace >::MField (  const MField< FieldTypeT, fieldNameSpace > &    obj )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> osg::MField< FieldTypeT, fieldNameSpace >::MField (  const UInt32    size )  [inline, explicit]

template<class FieldTypeT, Int32 fieldNameSpace> osg::MField< FieldTypeT, fieldNameSpace >::~MField (  void    )  [inline, virtual]

---

Member Function Documentation

template<class FieldTypeT, Int32 fieldNameSpace> const FieldType & osg::MField< FieldTypeT, fieldNameSpace >::getClassType (  void    )  [inline, static]

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::reference osg::MField< FieldTypeT, fieldNameSpace >::getValue (  const UInt32    index )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_reference osg::MField< FieldTypeT, fieldNameSpace >::getValue (  const UInt32    index )  const [inline]

template<class FieldTypeT, Int32 fieldNameSpace> UInt32 osg::MField< FieldTypeT, fieldNameSpace >::getSize (  void    )  const [inline, virtual]

Returns the size of the field, allway 1 for single fields. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::StorageType & osg::MField< FieldTypeT, fieldNameSpace >::getValues (  void    )  [inline]

Return a reference to the value store.

template<class FieldTypeT, Int32 fieldNameSpace> const MField< FieldTypeT, fieldNameSpace >::StorageType & osg::MField< FieldTypeT, fieldNameSpace >::getValues (  void    )  const [inline]

Return a const reference to the value store.

template<class FieldTypeT, Int32 fieldNameSpace> const FieldType & osg::MField< FieldTypeT, fieldNameSpace >::getType (  void    )  const [inline, virtual]

Returns the type of the field. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> bool osg::MField< FieldTypeT, fieldNameSpace >::isEmpty (  void    )  const [inline, virtual]

Returns the type of the field. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::setAbstrValue (  const Field &    obj )  [inline, virtual]

Copies the values from a given field iff the two fieldtypes are the same. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::setValues (  const StorageType &    value )  [inline]

Copies the values from a given value store.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::setValues (  const Self &    obj )  [inline]

Copies the values from a given field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::setValue (  ArgumentType    value, const UInt32    index )  [inline]

Copies the values from a given field iff the two fieldtypes are the same.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::addValue (  ArgumentType    value )  [inline]

Copies the values from a given field iff the two fieldtypes are the same.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::iterator osg::MField< FieldTypeT, fieldNameSpace >::begin (  void    )  [inline]

Return an iterator to the first element.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::iterator osg::MField< FieldTypeT, fieldNameSpace >::end (  void    )  [inline]

Return an iterator to the end of the store.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_iterator osg::MField< FieldTypeT, fieldNameSpace >::begin (  void    )  const [inline]

Return a const iterator to the first element.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_iterator osg::MField< FieldTypeT, fieldNameSpace >::end (  void    )  const [inline]

Return a const iterator to the end of the store.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::reference osg::MField< FieldTypeT, fieldNameSpace >::front (  void    )  [inline]

Returns an interator to the first element.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_reference osg::MField< FieldTypeT, fieldNameSpace >::front (  void    )  const [inline]

Returns a const interator to the first element.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::reference osg::MField< FieldTypeT, fieldNameSpace >::back (  void    )  [inline]

Returns an interator to the last element.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_reference osg::MField< FieldTypeT, fieldNameSpace >::back (  void    )  const [inline]

Returns a const interator to the last element.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::clear (  void    )  [inline]

Clears the value store.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::iterator osg::MField< FieldTypeT, fieldNameSpace >::insert (  iterator    pos, ArgumentType    value )  [inline]

Inserts value at the given pos.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::iterator osg::MField< FieldTypeT, fieldNameSpace >::erase (  iterator    pos )  [inline]

Removes values from the given pos.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::iterator osg::MField< FieldTypeT, fieldNameSpace >::find (  ArgumentType    value )  [inline]

Returns an iterator to the given value if found otherwise end().

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_iterator osg::MField< FieldTypeT, fieldNameSpace >::find (  ArgumentType    value )  const [inline]

Returns a const iterator to the given value if found otherwise end().

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::push_back (  ArgumentType    value )  [inline]

push back value

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::resize (  size_t    newsize, FieldTypeT    t = FieldTypeT() )  [inline]

resizes the container to given size. Depends on the underlying stll container implementation

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::reserve (  size_t    newsize )  [inline]

allocates memory for the given number of elements. Depends on the underlying stl container implementation

template<class FieldTypeT, Int32 fieldNameSpace> UInt32 osg::MField< FieldTypeT, fieldNameSpace >::size (  void    )  const [inline]

Returns the size of the field.

template<class FieldTypeT, Int32 fieldNameSpace> bool osg::MField< FieldTypeT, fieldNameSpace >::empty (  void    )  const [inline]

Returns true if the field does not hold any value.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::reference osg::MField< FieldTypeT, fieldNameSpace >::operator[] (  UInt32    index )  [inline]

Returns a reference to the value at the given index.

template<class FieldTypeT, Int32 fieldNameSpace> MField< FieldTypeT, fieldNameSpace >::const_reference osg::MField< FieldTypeT, fieldNameSpace >::operator[] (  UInt32    index )  const [inline]

Returns a const reference to the value at the given index.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::operator= (  const MField< FieldTypeT, fieldNameSpace > &    source )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::pushValueByStr (  const Char8 *    str )  [inline, virtual]

Sets the field value from a given string. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> string & osg::MField< FieldTypeT, fieldNameSpace >::getValueByStr (  string &    str )  const [inline, virtual]

Dump the field to a given string. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> string & osg::MField< FieldTypeT, fieldNameSpace >::getValueByStr (  string &    str, StringConversionStateBase &    state )  const [inline, virtual]

Sets the field value from a given string. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::syncWith (  Self &    source )  [inline]

UInt32 osg::MField<>::getBinSize (  void    )  [inline]

void osg::MField<>::copyToBin (  BinaryDataHandler &    pMem )  [inline]

void osg::MField<>::copyFromBin (  BinaryDataHandler &    pMem )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> void osg::MField< FieldTypeT, fieldNameSpace >::dump (  void    )  const [inline, virtual]

Dump property contents to stderr, should be changed to use a log stream instead. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> Field * osg::MField< FieldTypeT, fieldNameSpace >::create (  void    )  [inline, static, protected]

Create method used by the factory to create an instance.

---

Friends And Related Function Documentation

template<class FieldTypeT, Int32 fieldNameSpace = 0> friend class FieldContainer [friend]

---

Member Data Documentation

template<class FieldTypeT, Int32 fieldNameSpace = 0> const FieldType osg::MField< FieldTypeT, fieldNameSpace >::_fieldType [static, protected]

template<class FieldTypeT, Int32 fieldNameSpace = 0> StorageType osg::MField< FieldTypeT, fieldNameSpace >::_values [protected]

Value store.

---

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

• OSGMField.h
• OSGMField.inl
• OSGMFSysTypes.h

---