osgDB::XmlNode Class Reference

XmlNode class for very basic reading and writing of xml files. More...

Inheritance diagram for osgDB::XmlNode:

Classes
class	ControlMap
class	Input

Public Types
enum	NodeType {   UNASSIGNED, ATOM, NODE, GROUP,   ROOT, COMMENT, INFORMATION }
typedef std::map< std::string, std::string >	Properties
typedef std::vector< osg::ref_ptr< XmlNode > >	Children

Public Member Functions
	XmlNode ()
std::string	getTrimmedContents () const
bool	read (Input &input)
bool	write (std::ostream &fout, const std::string &indent="") const
bool	write (const ControlMap &controlMap, std::ostream &fout, const std::string &indent="") const
bool	writeString (const ControlMap &controlMap, std::ostream &fout, const std::string &str) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool)
	Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	referenceCount () const
	Return the number of pointers currently referencing this object. More...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Public Attributes
NodeType	type
std::string	name
std::string	contents
Properties	properties
Children	children

Protected Member Functions
bool	writeChildren (const ControlMap &controlMap, std::ostream &fout, const std::string &indent) const
bool	writeProperties (const ControlMap &controlMap, std::ostream &fout) const
bool	readAndReplaceControl (std::string &in_contents, Input &input) const
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Detailed Description

XmlNode class for very basic reading and writing of xml files.

Member Typedef Documentation

Children

typedef std::vector< osg::ref_ptr<XmlNode> > osgDB::XmlNode::Children

Properties

typedef std::map< std::string, std::string > osgDB::XmlNode::Properties

Member Enumeration Documentation

NodeType

enum osgDB::XmlNode::NodeType

Enumerator
UNASSIGNED
ATOM
NODE
GROUP
ROOT
COMMENT
INFORMATION

Constructor & Destructor Documentation

XmlNode()

osgDB::XmlNode::XmlNode

(

)

Member Function Documentation

getTrimmedContents()

std::string osgDB::XmlNode::getTrimmedContents ( ) const

inline

References osgDB::trimEnclosingSpaces().

read()

bool osgDB::XmlNode::read

(

Input &

input

)

readAndReplaceControl()

bool osgDB::XmlNode::readAndReplaceControl ( std::string &  in_contents, Input &  input  ) const

protected

write() [1/2]

bool osgDB::XmlNode::write	(	std::ostream &	fout,
		const std::string &	indent = ""
	)		const

write() [2/2]

bool osgDB::XmlNode::write	(	const ControlMap &	controlMap,
		std::ostream &	fout,
		const std::string &	indent = ""
	)		const

writeChildren()

bool osgDB::XmlNode::writeChildren ( const ControlMap &  controlMap, std::ostream &  fout, const std::string &  indent  ) const

protected

writeProperties()

bool osgDB::XmlNode::writeProperties ( const ControlMap &  controlMap, std::ostream &  fout  ) const

protected

writeString()

bool osgDB::XmlNode::writeString	(	const ControlMap &	controlMap,
		std::ostream &	fout,
		const std::string &	str
	)		const

Member Data Documentation

children

Children osgDB::XmlNode::children

contents

std::string osgDB::XmlNode::contents

name

std::string osgDB::XmlNode::name

properties

Properties osgDB::XmlNode::properties

type

NodeType osgDB::XmlNode::type

---

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

• osgDB/XmlParser