#include <ossimConnectionEvent.h>

Inheritance diagram for ossimConnectionEvent:

Public Types
enum	ossimConnectionDirectionType { OSSIM_DIRECTION_UNKNOWN = 0, OSSIM_INPUT_DIRECTION = 1, OSSIM_OUTPUT_DIRECTION = 2, OSSIM_INPUT_OUTPUT_DIRECTION = 3 }

Public Types inherited from ossimEvent
enum	PropagationType { PROPAGATION_NONE = 0, PROPAGATION_INPUT = 1, PROPAGATION_OUTPUT = 2 }

Public Member Functions
	ossimConnectionEvent (ossimObject *object=NULL, long id=OSSIM_EVENT_NULL_ID)

	ossimConnectionEvent (ossimObject *object, long id, const ossimConnectableObject::ConnectableObjectList &newList, const ossimConnectableObject::ConnectableObjectList &oldList, ossimConnectionDirectionType whichDirection)

	ossimConnectionEvent (ossimObject object, long id, ossimConnectableObject newConnectableObject, ossimConnectableObject *oldConnectableObject, ossimConnectionDirectionType whichDirection)

	ossimConnectionEvent (const ossimConnectionEvent &rhs)

ossimObject *	dup () const

virtual void	setDirection (ossimConnectionDirectionType direction)

virtual ossimConnectionDirectionType	getDirection () const

virtual ossim_uint32	getNumberOfNewObjects () const

virtual ossim_uint32	getNumberOfOldObjects () const

virtual ossimConnectableObject *	getOldObject (ossim_uint32 i=0)

virtual ossimConnectableObject *	getNewObject (ossim_uint32 i=0)

virtual bool	isDisconnect () const

virtual bool	isConnect () const

virtual bool	isInputDirection () const

virtual bool	isOutputDirection () const

Public Member Functions inherited from ossimEvent
	ossimEvent (ossimObject *object=NULL, long id=OSSIM_EVENT_NULL_ID)

	ossimEvent (const ossimEvent &rhs)

long	getId () const

void	setId (long id)

bool	isConsumed () const

void	setConsumedFlag (bool flag=true)

void	consume ()

const ossimObject *	getObject () const
	This is the originating object that originally produced the event. More...

ossimObject *	getObject ()

const ossimObject *	getCurrentObject () const

ossimObject *	getCurrentObject ()

void	setObject (ossimObject *object)

void	setCurrentObject (ossimObject *object)

void	setPropagationType (PropagationType type)

bool	isPropagatingToOutputs () const

bool	isPropagatingToInputs () const

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

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
ossimConnectableObject::ConnectableObjectList	theNewObjectList

ossimConnectableObject::ConnectableObjectList	theOldObjectList

ossimConnectionDirectionType	theDirectionType

Protected Attributes inherited from ossimEvent
ossimObject *	theObject

ossimObject *	theCurrentObject

long	theId

bool	theIsConsumedFlag

PropagationType	thePropagationType

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

Detailed Description

Definition at line 21 of file ossimConnectionEvent.h.

Member Enumeration Documentation

◆ ossimConnectionDirectionType

enum ossimConnectionEvent::ossimConnectionDirectionType

Enumerator
OSSIM_DIRECTION_UNKNOWN
OSSIM_INPUT_DIRECTION
OSSIM_OUTPUT_DIRECTION
OSSIM_INPUT_OUTPUT_DIRECTION

Definition at line 24 of file ossimConnectionEvent.h.

    {
       OSSIM_DIRECTION_UNKNOWN  = 0,
       OSSIM_INPUT_DIRECTION    = 1,
       OSSIM_OUTPUT_DIRECTION   = 2,
       OSSIM_INPUT_OUTPUT_DIRECTION = 3
    };

Constructor & Destructor Documentation

◆ ossimConnectionEvent() [1/4]

ossimConnectionEvent::ossimConnectionEvent	(	ossimObject *	object = `NULL`,
		long	id = `OSSIM_EVENT_NULL_ID`
	)

Definition at line 15 of file ossimConnectionEvent.cpp.

Referenced by dup().

    :ossimEvent(object, id),
     theDirectionType(OSSIM_DIRECTION_UNKNOWN)
 {
 }

◆ ossimConnectionEvent() [2/4]

ossimConnectionEvent::ossimConnectionEvent	(	ossimObject *	object,
		long	id,
		const ossimConnectableObject::ConnectableObjectList &	newList,
		const ossimConnectableObject::ConnectableObjectList &	oldList,
		ossimConnectionDirectionType	whichDirection
	)

Definition at line 21 of file ossimConnectionEvent.cpp.

    : ossimEvent(object, id),
      theNewObjectList(newList),
      theOldObjectList(oldList),
      theDirectionType(whichDirection)
 {
 }

◆ ossimConnectionEvent() [3/4]

ossimConnectionEvent::ossimConnectionEvent	(	ossimObject *	object,
		long	id,
		ossimConnectableObject *	newConnectableObject,
		ossimConnectableObject *	oldConnectableObject,
		ossimConnectionDirectionType	whichDirection
	)

Definition at line 34 of file ossimConnectionEvent.cpp.

References theNewObjectList, and theOldObjectList.

    : ossimEvent(object, id),
      theDirectionType(whichDirection)
 {
    if(newConnectableObject)
    {
       theNewObjectList.push_back(newConnectableObject);
    }
    if(oldConnectableObject)
    {
       theOldObjectList.push_back(oldConnectableObject);
    }
 }

◆ ossimConnectionEvent() [4/4]

ossimConnectionEvent::ossimConnectionEvent ( const ossimConnectionEvent & rhs )

Definition at line 53 of file ossimConnectionEvent.cpp.

    : ossimEvent(rhs),
      theNewObjectList(rhs.theNewObjectList),
      theOldObjectList(rhs.theOldObjectList),
      theDirectionType(rhs.theDirectionType)
 {
 }

Member Function Documentation

◆ dup()

ossimObject * ossimConnectionEvent::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 61 of file ossimConnectionEvent.cpp.

References ossimConnectionEvent().

 {
    return new ossimConnectionEvent(*this);
 }

◆ getDirection()

ossimConnectionEvent::ossimConnectionDirectionType ossimConnectionEvent::getDirection ( ) const

virtual

Definition at line 72 of file ossimConnectionEvent.cpp.

References theDirectionType.

 {
    return theDirectionType;
 }

◆ getNewObject()

ossimConnectableObject * ossimConnectionEvent::getNewObject ( ossim_uint32 i = 0 )

virtual

Definition at line 97 of file ossimConnectionEvent.cpp.

References getNumberOfNewObjects(), and theNewObjectList.

Referenced by ossimImageSourceHistogramFilter::connectInputEvent().

 {
    if(i < getNumberOfNewObjects())
    {
       return theNewObjectList[i].get();
    }
    
    return (ossimConnectableObject*)NULL;
 }

◆ getNumberOfNewObjects()

ossim_uint32 ossimConnectionEvent::getNumberOfNewObjects ( ) const

virtual

Definition at line 77 of file ossimConnectionEvent.cpp.

References theNewObjectList.

Referenced by getNewObject().

 {
    return (ossim_uint32)theNewObjectList.size();
 }

◆ getNumberOfOldObjects()

ossim_uint32 ossimConnectionEvent::getNumberOfOldObjects ( ) const

virtual

Definition at line 82 of file ossimConnectionEvent.cpp.

References theOldObjectList.

Referenced by getOldObject().

 {
    return (ossim_uint32)theOldObjectList.size();
 }

◆ getOldObject()

ossimConnectableObject * ossimConnectionEvent::getOldObject ( ossim_uint32 i = 0 )

virtual

Definition at line 87 of file ossimConnectionEvent.cpp.

References getNumberOfOldObjects(), and theOldObjectList.

Referenced by ossimHistogramWriter::connectInputEvent(), ossimHistogramWriter::disconnectInputEvent(), and ossimImageChain::disconnectInputEvent().

 {
    if(i < getNumberOfOldObjects())
    {
       return theOldObjectList[i].get();
    }
    
    return (ossimConnectableObject*)NULL;
 }

◆ isConnect()

bool ossimConnectionEvent::isConnect ( ) const

virtual

Definition at line 112 of file ossimConnectionEvent.cpp.

References ossimEvent::getId(), and OSSIM_EVENT_CONNECTION_CONNECT_ID.

 {
    return (getId()==OSSIM_EVENT_CONNECTION_CONNECT_ID);
 }

◆ isDisconnect()

bool ossimConnectionEvent::isDisconnect ( ) const

virtual

Definition at line 107 of file ossimConnectionEvent.cpp.

References ossimEvent::getId(), and OSSIM_EVENT_CONNECTION_DISCONNECT_ID.

 {
    return (getId()==OSSIM_EVENT_CONNECTION_DISCONNECT_ID);
 }

◆ isInputDirection()

bool ossimConnectionEvent::isInputDirection ( ) const

virtual

Definition at line 117 of file ossimConnectionEvent.cpp.

References OSSIM_INPUT_DIRECTION, and theDirectionType.

Referenced by ossimConnectableObjectListener::processEvent(), and ossimConnectableDisplayListener::processEvent().

 {
    return ((long)theDirectionType  & (long)OSSIM_INPUT_DIRECTION);
 }

◆ isOutputDirection()

bool ossimConnectionEvent::isOutputDirection ( ) const

virtual

Definition at line 122 of file ossimConnectionEvent.cpp.

References OSSIM_OUTPUT_DIRECTION, and theDirectionType.

Referenced by ossimConnectableObjectListener::processEvent(), and ossimConnectableDisplayListener::processEvent().

 {
    return ((long)theDirectionType & OSSIM_OUTPUT_DIRECTION);
 }

◆ setDirection()

void ossimConnectionEvent::setDirection ( ossimConnectionDirectionType direction )

virtual

Definition at line 66 of file ossimConnectionEvent.cpp.

References theDirectionType.

 {
    theDirectionType   = direction;
 }

Member Data Documentation

◆ theDirectionType

ossimConnectionDirectionType ossimConnectionEvent::theDirectionType

protected

Definition at line 74 of file ossimConnectionEvent.h.

Referenced by getDirection(), isInputDirection(), isOutputDirection(), and setDirection().

◆ theNewObjectList

ossimConnectableObject::ConnectableObjectList ossimConnectionEvent::theNewObjectList

protected

Definition at line 72 of file ossimConnectionEvent.h.

Referenced by getNewObject(), getNumberOfNewObjects(), and ossimConnectionEvent().

◆ theOldObjectList

ossimConnectableObject::ConnectableObjectList ossimConnectionEvent::theOldObjectList

protected

Definition at line 73 of file ossimConnectionEvent.h.

Referenced by getNumberOfOldObjects(), getOldObject(), and ossimConnectionEvent().

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

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ossimConnectionDirectionType

Constructor & Destructor Documentation

◆ ossimConnectionEvent() [1/4]

◆ ossimConnectionEvent() [2/4]

◆ ossimConnectionEvent() [3/4]

◆ ossimConnectionEvent() [4/4]

Member Function Documentation

◆ dup()

◆ getDirection()

◆ getNewObject()

◆ getNumberOfNewObjects()

◆ getNumberOfOldObjects()

◆ getOldObject()

◆ isConnect()

◆ isDisconnect()

◆ isInputDirection()

◆ isOutputDirection()

◆ setDirection()

Member Data Documentation

◆ theDirectionType

◆ theNewObjectList

◆ theOldObjectList