ossimConnectableContainerInterface Class Reference

#include <ossimConnectableContainerInterface.h>

Inheritance diagram for ossimConnectableContainerInterface:

Public Member Functions
	ossimConnectableContainerInterface (ossimObject *obj)
virtual	~ossimConnectableContainerInterface ()
virtual ossimConnectableObject::ConnectableObjectList	findAllObjectsOfType (const RTTItypeid &typeInfo, bool recurse=true)=0
virtual ossimConnectableObject::ConnectableObjectList	findAllObjectsOfType (const ossimString &className, bool recurse=true)=0
virtual ossimConnectableObject *	findFirstObjectOfType (const RTTItypeid &typeInfo, bool recurse=true)=0
virtual ossimConnectableObject *	findFirstObjectOfType (const ossimString &className, bool recurse=true)=0
virtual ossimConnectableObject *	findObject (const ossimId &id, bool recurse=true)=0
virtual ossimConnectableObject *	findObject (const ossimConnectableObject *obj, bool recurse=true)=0
virtual void	makeUniqueIds ()=0
virtual ossim_uint32	getNumberOfObjects (bool recurse=true) const =0
virtual bool	addChild (ossimConnectableObject *attachableObject)=0
virtual bool	removeChild (ossimConnectableObject *object)=0
ossimObject *	getObject ()
const ossimObject *	getObject () const
virtual ossimConnectableObject *	getConnectableObject (ossim_uint32 index)=0
void	deleteAllChildren ()
virtual void	getChildren (std::vector< ossimConnectableObject *> &children, bool immediateChildrenOnlyFlag)=0

Protected Attributes
ossimObject *	theBaseObject

Detailed Description

Definition at line 23 of file ossimConnectableContainerInterface.h.

Constructor & Destructor Documentation

ossimConnectableContainerInterface()

ossimConnectableContainerInterface::ossimConnectableContainerInterface ( ossimObject *  obj )

inline

Definition at line 26 of file ossimConnectableContainerInterface.h.

:theBaseObject(obj){}

~ossimConnectableContainerInterface()

virtual ossimConnectableContainerInterface::~ossimConnectableContainerInterface ( )

inlinevirtual

Definition at line 27 of file ossimConnectableContainerInterface.h.

{theBaseObject=NULL;}

Member Function Documentation

addChild()

virtual bool ossimConnectableContainerInterface::addChild ( ossimConnectableObject *  attachableObject )

pure virtual

Will add an object to the container and then set the added objects owner to this.

Implemented in ossimImageChain, and ossimConnectableContainer.

deleteAllChildren()

void ossimConnectableContainerInterface::deleteAllChildren

(

)

findAllObjectsOfType() [1/2]

virtual ossimConnectableObject::ConnectableObjectList ossimConnectableContainerInterface::findAllObjectsOfType ( const RTTItypeid &  typeInfo, bool  recurse = true  )

pure virtual

Will find all objects of the past in type. Use the RTTI type info. An optional recurse flag will say if there is another container then recurse it to find the type you are looking for else it just looks within its immediate children

Example: passing STATIC_TYPE_INFO(ossimImageRenderer) as an argument will look for all ossimImageRenderer's and return the list.

Referenced by ossimGdalWriter::checkColorLut(), ossimTiffWriter::checkColorLut(), ossimViewController::findFirstViewOfType(), and ossimViewController::propagateView().

findAllObjectsOfType() [2/2]

virtual ossimConnectableObject::ConnectableObjectList ossimConnectableContainerInterface::findAllObjectsOfType ( const ossimString &  className, bool  recurse = true  )

pure virtual

findFirstObjectOfType() [1/2]

virtual ossimConnectableObject* ossimConnectableContainerInterface::findFirstObjectOfType ( const RTTItypeid &  typeInfo, bool  recurse = true  )

pure virtual

Will find the firt object of the past in type. Use the RTTI type info.An optional recurse flag will say if there is another container then recurse it to find the type you are looking for else it just looks within its immediate children

Example: passing STATIC_TYPE_INFO(ossimImageRenderer) as an argument will look for the first ossimImageRenderer and return that object.

findFirstObjectOfType() [2/2]

virtual ossimConnectableObject* ossimConnectableContainerInterface::findFirstObjectOfType ( const ossimString &  className, bool  recurse = true  )

pure virtual

findObject() [1/2]

virtual ossimConnectableObject* ossimConnectableContainerInterface::findObject ( const ossimId &  id, bool  recurse = true  )

pure virtual

will search for the object given an id. If recurse is true it will recurse to other containers.

Referenced by ossimImageChain::connectAllSources(), ossimImageChain::insertLeft(), and ossimImageChain::insertRight().

findObject() [2/2]

virtual ossimConnectableObject* ossimConnectableContainerInterface::findObject ( const ossimConnectableObject *  obj, bool  recurse = true  )

pure virtual

getChildren()

virtual void ossimConnectableContainerInterface::getChildren ( std::vector< ossimConnectableObject *> &  children, bool  immediateChildrenOnlyFlag  )

pure virtual

Implemented in ossimConnectableContainer.

Referenced by ossimConnectableContainer::getChildren().

getConnectableObject()

virtual ossimConnectableObject* ossimConnectableContainerInterface::getConnectableObject ( ossim_uint32  index )

pure virtual

Parameters

index

Index of object to get.

See also

getNumberOfObjects(false) to get the number of objects inside the container.

Returns

Container's object at that index or NULL if out of range.

Note

This does not recurse into other containers.

Implemented in ossimImageChain, and ossimConnectableContainer.

getNumberOfObjects()

virtual ossim_uint32 ossimConnectableContainerInterface::getNumberOfObjects ( bool  recurse = true ) const

pure virtual

Returns the number of objects within this container and all child containers.

Implemented in ossimImageChain, and ossimConnectableContainer.

Referenced by ossimConnectableContainer::getNumberOfObjects(), and ossimImageChain::getNumberOfObjects().

getObject() [1/2]

ossimObject* ossimConnectableContainerInterface::getObject ( )

inline

Gives access to the this point of the base object that everyone derives from.

Definition at line 95 of file ossimConnectableContainerInterface.h.

{return theBaseObject;}

getObject() [2/2]

const ossimObject* ossimConnectableContainerInterface::getObject ( ) const

inline

Definition at line 96 of file ossimConnectableContainerInterface.h.

{return theBaseObject;}

makeUniqueIds()

virtual void ossimConnectableContainerInterface::makeUniqueIds ( )

pure virtual

Will cycle through all sources setting their ids. the idLast wlil be updated so we can recurse into other containers.

Implemented in ossimImageChain, and ossimConnectableContainer.

Referenced by ossimConnectableContainer::makeUniqueIds(), and ossimImageChain::makeUniqueIds().

removeChild()

virtual bool ossimConnectableContainerInterface::removeChild ( ossimConnectableObject *  object )

pure virtual

Will remove the child from the container. Changes the owner of the child to be NULL;

Implemented in ossimImageChain, and ossimConnectableContainer.

Member Data Documentation

theBaseObject

ossimObject* ossimConnectableContainerInterface::theBaseObject

protected

Definition at line 114 of file ossimConnectableContainerInterface.h.

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

---

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

• ossimConnectableContainerInterface.h