SoSFMLBase Class Reference

The SoSFMLBase field is the interface used by Inventor Nodes to output ML Base objects to the outside world. More...

#include <SoSFMLBase.h>

List of all members.

Public Member Functions
void	addAllowedType (const ml::RuntimeType *allowedType)
	Add type to list of allowed types.
template<typename T >
void	addAllowedType ()
	Same as above, with template parameter where the Base type can be specified directly.
std::vector< const ml::RuntimeType * >	getAllowedTypes () const
	Get list of allowed Base types for this field.
bool	hasUnallowedType () const
	return true if the last call of setBaseValue had an unallowed type as argument, getBaseValue will return NULL then
virtual void	setValue (ml::Base *mlBasePtr)
virtual ml::Base *	getValue () const
virtual int	readValue (SoInput *in)
virtual void	writeValue (SoOutput *out) const
Static Public Member Functions
static void	initClass ()
	Initializes field class, setting up runtime type info.
Protected Attributes
ml::Base *	_value
	pointer to the stored base object
std::vector< const ml::RuntimeType * >	_allowedTypes
	List of allowed Base types. If empty, any type is allowed.
bool	_unallowedType
	remember if an unallowed type was assigned to this field
bool	_isRefCountedBase

---

Detailed Description

The SoSFMLBase field is the interface used by Inventor Nodes to output ML Base objects to the outside world.

The initial value for input fields should be NULL. ILAB4 and MeVisLab use the name of the field to decide if it is an input or output field. If the name starts with out, it is an output field. Reading and writing to a scene is not implemented.

Author:

Florian Link

Definition at line 52 of file SoSFMLBase.h.

---

Member Function Documentation

template<typename T >

void SoSFMLBase::addAllowedType

(

)

[inline]

Same as above, with template parameter where the Base type can be specified directly.

Definition at line 78 of file SoSFMLBase.h.

References addAllowedType().

Referenced by addAllowedType().

void SoSFMLBase::addAllowedType

(

const ml::RuntimeType *

allowedType

)

Add type to list of allowed types.

This will set the Base value to NULL if it isn't NULL already and should only be called when initializing the SoSFMLField. Calls to setValue (or setStringValue) will only succeed if the given Base object is of one of the allowed types or NULL, or if the list is empty, otherwise NULL will be set instead.

std::vector<const ml ::RuntimeType*> SoSFMLBase::getAllowedTypes

(

)

const [inline]

Get list of allowed Base types for this field.

Definition at line 81 of file SoSFMLBase.h.

virtual ml ::Base* SoSFMLBase::getValue

(

)

const [virtual]

bool SoSFMLBase::hasUnallowedType

(

)

const [inline]

return true if the last call of setBaseValue had an unallowed type as argument, getBaseValue will return NULL then

Definition at line 85 of file SoSFMLBase.h.

static void SoSFMLBase::initClass

(

)

[static]

Initializes field class, setting up runtime type info.

virtual int SoSFMLBase::readValue

(

SoInput *

in

)

[virtual]

virtual void SoSFMLBase::setValue

(

ml::Base *

mlBasePtr

)

[virtual]

virtual void SoSFMLBase::writeValue

(

SoOutput *

out

)

const [virtual]

---

Member Data Documentation

std::vector<const ml ::RuntimeType*> SoSFMLBase::_allowedTypes [protected]

List of allowed Base types. If empty, any type is allowed.

Definition at line 92 of file SoSFMLBase.h.

bool SoSFMLBase::_isRefCountedBase [protected]

Definition at line 96 of file SoSFMLBase.h.

bool SoSFMLBase::_unallowedType [protected]

remember if an unallowed type was assigned to this field

Definition at line 95 of file SoSFMLBase.h.

ml ::Base* SoSFMLBase::_value [protected]

pointer to the stored base object

Definition at line 89 of file SoSFMLBase.h.

---

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

• MeVis/Foundation/Sources/MLInventorBinding/SoSFMLBase.h