OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | Protected Attributes | List of all members
ossimIdVisitor Class Reference

#include <ossimVisitor.h>

Inheritance diagram for ossimIdVisitor:
ossimVisitor ossimReferenced

Public Member Functions

 ossimIdVisitor ()
 Default constructor Constructs with id of 0 and vistor type of VISIT_INPUTS|VISIT_CHILDREN. More...
 
 ossimIdVisitor (int visitorType)
 
 ossimIdVisitor (const ossimId &id, int visitorType=(VISIT_INPUTS|VISIT_CHILDREN))
 
 ossimIdVisitor (const ossimIdVisitor &src)
 
virtual ossimRefPtr< ossimVisitordup () const
 
virtual void visit (ossimConnectableObject *obj)
 
virtual void reset ()
 Resets m_object to 0, calls ossimVisitor::reset(). More...
 
ossimConnectableObjectgetObject ()
 
const ossimConnectableObjectgetObject () const
 
void setId (const ossimId &id)
 
const ossimIdgetId () const
 
- Public Member Functions inherited from ossimVisitor
 ossimVisitor (int visitorType=VISIT_NONE)
 
 ossimVisitor (const ossimVisitor &src)
 
virtual void visit (ossimObject *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 &)
 
ossimReferencedoperator= (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

ossimConnectableObjectm_object
 
ossimId m_id
 
- Protected Attributes inherited from ossimVisitor
VisitorType m_visitorType
 
Collection m_markNode
 
bool m_stopTraversalFlag
 

Additional Inherited Members

- Public Types inherited from ossimVisitor
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
 
- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 

Detailed Description

Definition at line 90 of file ossimVisitor.h.

Constructor & Destructor Documentation

◆ ossimIdVisitor() [1/4]

ossimIdVisitor::ossimIdVisitor ( )

Default constructor Constructs with id of 0 and vistor type of VISIT_INPUTS|VISIT_CHILDREN.

Definition at line 73 of file ossimVisitor.cpp.

Referenced by dup().

74  :
76  m_object(0),
77  m_id(0)
78 {
79 }
ossimVisitor(int visitorType=VISIT_NONE)
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

◆ ossimIdVisitor() [2/4]

ossimIdVisitor::ossimIdVisitor ( int  visitorType)

Definition at line 81 of file ossimVisitor.cpp.

82  :
83  ossimVisitor(visitorType),
84  m_object(0),
85  m_id(0)
86 {
87 }
ossimVisitor(int visitorType=VISIT_NONE)
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

◆ ossimIdVisitor() [3/4]

ossimIdVisitor::ossimIdVisitor ( const ossimId id,
int  visitorType = (VISIT_INPUTS|VISIT_CHILDREN) 
)

Definition at line 89 of file ossimVisitor.cpp.

90  :
91  ossimVisitor(visitorType),
92  m_object(0),
93  m_id(id)
94 {
95 }
ossimVisitor(int visitorType=VISIT_NONE)
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

◆ ossimIdVisitor() [4/4]

ossimIdVisitor::ossimIdVisitor ( const ossimIdVisitor src)

Definition at line 97 of file ossimVisitor.cpp.

98  :
99  ossimVisitor(src),
100  m_object(src.m_object),
101  m_id(src.m_id)
102 {
103 }
ossimVisitor(int visitorType=VISIT_NONE)
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

Member Function Documentation

◆ dup()

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

Implements ossimVisitor.

Definition at line 105 of file ossimVisitor.cpp.

References ossimIdVisitor().

106 {
107  return new ossimIdVisitor(*this);
108 }
ossimIdVisitor()
Default constructor Constructs with id of 0 and vistor type of VISIT_INPUTS|VISIT_CHILDREN.

◆ getId()

const ossimId & ossimIdVisitor::getId ( ) const

Definition at line 144 of file ossimVisitor.cpp.

References m_id.

145 {
146  return m_id;
147 }

◆ getObject() [1/2]

ossimConnectableObject * ossimIdVisitor::getObject ( )

◆ getObject() [2/2]

const ossimConnectableObject * ossimIdVisitor::getObject ( ) const

Definition at line 134 of file ossimVisitor.cpp.

References m_object.

135 {
136  return m_object;
137 }
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

◆ reset()

void ossimIdVisitor::reset ( void  )
virtual

Resets m_object to 0, calls ossimVisitor::reset().

Reimplemented from ossimVisitor.

Definition at line 123 of file ossimVisitor.cpp.

References m_object, and ossimVisitor::reset().

Referenced by ossimConnectableContainer::connectAllObjects(), and ossimImageChain::connectAllSources().

124 {
126  m_object = 0;
127 }
virtual void reset()
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

◆ setId()

void ossimIdVisitor::setId ( const ossimId id)

Definition at line 139 of file ossimVisitor.cpp.

References m_id.

Referenced by ossimConnectableContainer::connectAllObjects(), and ossimImageChain::connectAllSources().

140 {
141  m_id = id;
142 }

◆ visit()

void ossimIdVisitor::visit ( ossimConnectableObject obj)
virtual

Reimplemented from ossimVisitor.

Definition at line 110 of file ossimVisitor.cpp.

References ossimConnectableObject::getId(), ossimVisitor::hasVisited(), m_id, m_object, ossimVisitor::m_stopTraversalFlag, and ossimVisitor::visit().

111 {
112  if ( !hasVisited(obj) )
113  {
114  if(obj->getId() == m_id)
115  {
116  m_object = obj;
117  m_stopTraversalFlag = true;
118  }
119  ossimVisitor::visit(obj);
120  }
121 }
virtual void visit(ossimObject *obj)
bool m_stopTraversalFlag
Definition: ossimVisitor.h:50
const ossimId & getId() const
Will allow us to get this object&#39;s id.
bool hasVisited(ossimObject *obj) const
ossimConnectableObject * m_object
Definition: ossimVisitor.h:114

Member Data Documentation

◆ m_id

ossimId ossimIdVisitor::m_id
protected

Definition at line 115 of file ossimVisitor.h.

Referenced by getId(), setId(), and visit().

◆ m_object

ossimConnectableObject* ossimIdVisitor::m_object
protected

Definition at line 114 of file ossimVisitor.h.

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


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