ossimVisitor Class Reference

#include <ossimVisitor.h>

Inheritance diagram for ossimVisitor:

Public Types
enum	VisitorType {   VISIT_NONE = 0, VISIT_CHILDREN = 1, VISIT_INPUTS = 2, VISIT_OUTPUTS = 4,   VISIT_ALL = (VISIT_CHILDREN|VISIT_INPUTS|VISIT_OUTPUTS) }
	Enumeration type can be a mask and will traverse a graph of connectables based on the values. More...
typedef std::set< ossimRefPtr< ossimObject > >	MarkCollectionRef
typedef std::set< ossimRefPtr< ossimObject > >	CollectionRef
typedef std::vector< ossimRefPtr< ossimObject > >	ListRef
typedef std::set< ossimObject * >	Collection
typedef std::vector< ossimObject *>	List

Public Member Functions
	ossimVisitor (int visitorType=VISIT_NONE)
	ossimVisitor (const ossimVisitor &src)
virtual void	reset ()
virtual ossimRefPtr< ossimVisitor >	dup () const =0
virtual void	visit (ossimObject *obj)
virtual void	visit (ossimConnectableObject *obj)
VisitorType	getVisitorType () const
void	setVisitorType (int vType, bool on=true)
void	turnOffVisitorType (int vType)
bool	hasVisited (ossimObject *obj) const
bool	stopTraversal () const
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Attributes
VisitorType	m_visitorType
Collection	m_markNode
bool	m_stopTraversalFlag

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 16 of file ossimVisitor.h.

Member Typedef Documentation

Collection

typedef std::set<ossimObject*> ossimVisitor::Collection

Definition at line 22 of file ossimVisitor.h.

CollectionRef

typedef std::set<ossimRefPtr<ossimObject> > ossimVisitor::CollectionRef

Definition at line 20 of file ossimVisitor.h.

List

typedef std::vector<ossimObject* > ossimVisitor::List

Definition at line 23 of file ossimVisitor.h.

ListRef

typedef std::vector<ossimRefPtr<ossimObject> > ossimVisitor::ListRef

Definition at line 21 of file ossimVisitor.h.

MarkCollectionRef

typedef std::set<ossimRefPtr<ossimObject> > ossimVisitor::MarkCollectionRef

Definition at line 19 of file ossimVisitor.h.

Member Enumeration Documentation

VisitorType

enum ossimVisitor::VisitorType

Enumeration type can be a mask and will traverse a graph of connectables based on the values.

Enumerator
VISIT_NONE
VISIT_CHILDREN
VISIT_INPUTS
VISIT_OUTPUTS
VISIT_ALL

Definition at line 27 of file ossimVisitor.h.

   {
      VISIT_NONE     = 0,
      VISIT_CHILDREN = 1,
      VISIT_INPUTS   = 2,
      VISIT_OUTPUTS  = 4,
      VISIT_ALL      = (VISIT_CHILDREN|VISIT_INPUTS|VISIT_OUTPUTS)
   };

Constructor & Destructor Documentation

ossimVisitor() [1/2]

ossimVisitor::ossimVisitor

(

int

visitorType = VISIT_NONE

)

Definition at line 10 of file ossimVisitor.cpp.

:m_visitorType(static_cast<VisitorType>(visitorType)),
m_stopTraversalFlag(false)
{
   
}

ossimVisitor() [2/2]

ossimVisitor::ossimVisitor

(

const ossimVisitor &

src

)

Definition at line 17 of file ossimVisitor.cpp.

:m_visitorType(src.m_visitorType),
m_markNode(src.m_markNode),
m_stopTraversalFlag(src.m_stopTraversalFlag)
{
}

Member Function Documentation

dup()

virtual ossimRefPtr<ossimVisitor> ossimVisitor::dup ( ) const

pure virtual

Implemented in ossimSourceInitializeVisitor, ossimViewInterfaceVisitor, ossimEventVisitor, ossimTypeIdVisitor, ossimTypeNameVisitor, ossimIdVisitor, ossimElevManager::ConnectionStringVisitor, and ossimIvtGeomXformVisitor.

getVisitorType()

ossimVisitor::VisitorType ossimVisitor::getVisitorType

(

)

const

Definition at line 24 of file ossimVisitor.cpp.

References m_visitorType.

Referenced by ossimContainerProperty::accept(), ossimConnectableContainer::accept(), ossimImageChain::accept(), and ossimConnectableObject::accept().

{
   return m_visitorType;
}

hasVisited()

bool ossimVisitor::hasVisited

(

ossimObject *

obj

)

const

Definition at line 62 of file ossimVisitor.cpp.

References m_markNode.

Referenced by ossimContainerProperty::accept(), ossimObject::accept(), ossimConnectableContainer::accept(), ossimImageChain::accept(), ossimConnectableObject::accept(), ossimIvtGeomXformVisitor::visit(), ossimIdVisitor::visit(), ossimTypeNameVisitor::visit(), ossimTypeIdVisitor::visit(), ossimEventVisitor::visit(), ossimViewInterfaceVisitor::visit(), and ossimSourceInitializeVisitor::visit().

{
   return m_markNode.find(obj) != m_markNode.end(); 
}

reset()

void ossimVisitor::reset ( void  )

virtual

Reimplemented in ossimIdVisitor, and ossimCollectionVisitor.

Definition at line 46 of file ossimVisitor.cpp.

References m_markNode, and m_stopTraversalFlag.

Referenced by ossimCollectionVisitor::reset(), and ossimIdVisitor::reset().

{
   m_markNode.clear();
   m_stopTraversalFlag = false;
}

setVisitorType()

void ossimVisitor::setVisitorType	(	int	vType,
		bool	on = true
	)

Definition at line 29 of file ossimVisitor.cpp.

References m_visitorType, and VISIT_ALL.

Referenced by ossimConnectableContainer::accept(), ossimImageChain::accept(), ossimConnectableObject::accept(), and turnOffVisitorType().

{
   if(on)
   {
      m_visitorType = (VisitorType)((vType|m_visitorType)&VISIT_ALL);
   }
   else 
   {
      m_visitorType = (VisitorType)(((~vType) & m_visitorType)&VISIT_ALL);
   }
}

stopTraversal()

bool ossimVisitor::stopTraversal

(

)

const

Definition at line 67 of file ossimVisitor.cpp.

References m_stopTraversalFlag.

Referenced by ossimObject::accept(), ossimElevManager::accept(), ossimConnectableContainer::accept(), ossimImageChain::accept(), and ossimConnectableObject::accept().

{
   return m_stopTraversalFlag;
}

turnOffVisitorType()

void ossimVisitor::turnOffVisitorType

(

int

vType

)

Definition at line 41 of file ossimVisitor.cpp.

References setVisitorType().

Referenced by ossimConnectableContainer::accept(), ossimImageChain::accept(), and ossimConnectableObject::accept().

{
   setVisitorType(vType, false);
}

visit() [1/2]

void ossimVisitor::visit ( ossimObject *  obj )

virtual

Reimplemented in ossimSourceInitializeVisitor, ossimViewInterfaceVisitor, ossimEventVisitor, ossimTypeIdVisitor, ossimTypeNameVisitor, ossimElevManager::ConnectionStringVisitor, and ossimIvtGeomXformVisitor.

Definition at line 52 of file ossimVisitor.cpp.

References m_markNode.

Referenced by ossimObject::accept(), ossimConnectableContainer::accept(), ossimImageChain::accept(), ossimConnectableObject::accept(), ossimIvtGeomXformVisitor::visit(), visit(), ossimIdVisitor::visit(), ossimTypeNameVisitor::visit(), ossimTypeIdVisitor::visit(), ossimEventVisitor::visit(), ossimViewInterfaceVisitor::visit(), and ossimSourceInitializeVisitor::visit().

{
   m_markNode.insert(obj);
}

visit() [2/2]

void ossimVisitor::visit ( ossimConnectableObject *  obj )

virtual

Reimplemented in ossimIdVisitor.

Definition at line 57 of file ossimVisitor.cpp.

References visit().

{
   visit(static_cast<ossimObject*>(obj));
}

Member Data Documentation

m_markNode

Collection ossimVisitor::m_markNode

mutableprotected

Definition at line 49 of file ossimVisitor.h.

Referenced by hasVisited(), reset(), and visit().

m_stopTraversalFlag

bool ossimVisitor::m_stopTraversalFlag

mutableprotected

Definition at line 50 of file ossimVisitor.h.

Referenced by reset(), stopTraversal(), ossimIdVisitor::visit(), ossimTypeNameVisitor::visit(), and ossimTypeIdVisitor::visit().

m_visitorType

VisitorType ossimVisitor::m_visitorType

protected

Definition at line 48 of file ossimVisitor.h.

Referenced by getVisitorType(), and setVisitorType().

---

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

• ossimVisitor.h
• ossimVisitor.cpp