#include <ossimOutputSource.h>

Inheritance diagram for ossimOutputSource:

Public Member Functions
	ossimOutputSource (ossimObject *owner=NULL)

	ossimOutputSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimOutputSource ()

virtual bool	isOpen () const =0

virtual bool	open ()=0

virtual bool	open (const ossimString &outputName)

virtual void	setOutputName (const ossimString &outputName)

virtual const ossimString &	getOutputName ()

virtual void	close ()=0

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

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

Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)

	ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimSource ()

virtual bool	isSourceEnabled () const

virtual void	enableSource ()

virtual void	disableSource ()

virtual bool	getEnableFlag () const

virtual void	setEnableFlag (bool flag)

virtual bool	isInitialized () const

virtual void	setInitializedFlag (bool flag)

virtual void	initialize ()

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const

virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...

	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimConnectableObject ()

void	setId (const ossimId &id)
	All connectable objects will have id's. More...

const ossimId &	getId () const
	Will allow us to get this object's id. More...

const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...

virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...

virtual void	setDescription (const ossimString &description)

virtual ossimString	getDescription () const

virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))

virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...

virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual bool	canConnectMyInputTo (ossim_int32 myInputIndex, const ossimConnectableObject *object) const =0
	required to be overriden by derived classes More...

virtual bool	canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
	default implementation is to allow anyone to connect to us. More...

virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...

virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...

virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...

virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...

virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...

virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...

virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...

virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...

virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...

virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)

virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...

virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)

virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...

virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...

virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...

virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...

ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...

virtual bool	getInputListIsFixedFlag () const

virtual bool	getOutputListIsFixedFlag () const

virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...

const ConnectableObjectList &	getInputList () const

const ConnectableObjectList &	getOutputList () const

ConnectableObjectList &	getInputList ()

ConnectableObjectList &	getOutputList ()

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))

virtual void	propagateEventToOutputs (ossimEvent &event)

virtual void	propagateEventToInputs (ossimEvent &event)

virtual void	setProperty (const ossimString &name, const ossimString &value)

virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...

virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...

bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...

bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...

bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...

bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...

virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () 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	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) 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

Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	addListener (ossimListener *listener)

virtual bool	removeListener (ossimListener *listener)

virtual bool	findListener (ossimListener *listener)

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const

void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Protected Attributes
ossimString	theOutputName

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...

bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...

ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...

ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...

Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Additional Inherited Members
Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }

typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)

const ossimSource &	operator= (const ossimSource &rhs)

Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Detailed Description

Definition at line 19 of file ossimOutputSource.h.

Constructor & Destructor Documentation

◆ ossimOutputSource() [1/2]

ossimOutputSource::ossimOutputSource ( ossimObject * owner = NULL )

inline

Definition at line 22 of file ossimOutputSource.h.

23 :ossimSource(owner)

24 {}

ossimSource::ossimSource

ossimSource(ossimObject *owner=0)

◆ ossimOutputSource() [2/2]

ossimOutputSource::ossimOutputSource	(	ossimObject *	owner,
		ossim_uint32	inputListSize,
		ossim_uint32	outputListSize,
		bool	inputListIsFixedFlag = `true`,
		bool	outputListIsFixedFlag = `true`
	)

inline

Definition at line 25 of file ossimOutputSource.h.

       :ossimSource(owner,
                    inputListSize,
                    outputListSize,
                    inputListIsFixedFlag,
                   outputListIsFixedFlag)
       {
       }

◆ ~ossimOutputSource()

virtual ossimOutputSource::~ossimOutputSource ( )

inlinevirtual

Definition at line 38 of file ossimOutputSource.h.

38 {}

Member Function Documentation

◆ close()

virtual void ossimOutputSource::close ( )

pure virtual

Generic interface to allow one to close a consumer. For displays this might minimize the window and free up internal pointers for file writers it will make sure the file stream is closed and flushed.

Implemented in ossimGpkgWriter, ossimBitMaskWriter, ossimPdfWriter, ossimWriter, ossimVertexExtractor, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimTiffWriter, ossimGeneralRasterWriter, ossimHistogramWriter, ossimGdalWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimNitfWriter, ossimNitf20Writer, and ossimArcInfoGridWriter.

◆ getOutputName()

virtual const ossimString& ossimOutputSource::getOutputName ( )

inlinevirtual

Definition at line 69 of file ossimOutputSource.h.

   {
     return theOutputName;
   }

◆ isOpen()

virtual bool ossimOutputSource::isOpen ( ) const

pure virtual

Implemented in ossimGpkgWriter, ossimBitMaskWriter, ossimPdfWriter, ossimWriter, ossimVertexExtractor, ossimPngWriter, ossimTiffWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimGeneralRasterWriter, ossimGdalWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimHistogramWriter, ossimNitfWriter, ossimNitf20Writer, and ossimArcInfoGridWriter.

◆ loadState()

bool ossimOutputSource::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimSource.

Reimplemented in ossimImageFileWriter, ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimNitfWriterBase, ossimGpkgWriter, ossimBitMaskWriter, ossimNitfWriter, ossimNitf20Writer, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimHistogramWriter, ossimGeneralRasterWriter, ossimGdalWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimImageWriter, and ossimArcInfoGridWriter.

Definition at line 11 of file ossimOutputSource.cpp.

References ossimSource::loadState().

Referenced by ossimImageWriter::loadState(), and ossimHistogramWriter::loadState().

 {
    return ossimSource::loadState(kwl, prefix);
 }

◆ open() [1/2]

virtual bool ossimOutputSource::open ( )

pure virtual

Allows a generic interface to open a consumer for writing. If you are a display writer then you would probably show the window or init the device context for writing.

Implemented in ossimGpkgWriter, ossimBitMaskWriter, ossimPdfWriter, ossimWriter, ossimVertexExtractor, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimTiffWriter, ossimGeneralRasterWriter, ossimGdalWriter, ossimHistogramWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimNitfWriter, ossimNitf20Writer, and ossimArcInfoGridWriter.

Referenced by ossimHistogramWriter::open(), and ossimImageFileWriter::writeHistogramFile().

◆ open() [2/2]

virtual bool ossimOutputSource::open ( const ossimString & outputName )

inlinevirtual

Will set the output name and open the output device.

Definition at line 52 of file ossimOutputSource.h.

       {
          setOutputName(outputName);
          return open();
       }

◆ saveState()

bool ossimOutputSource::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Method to save the state of the object to a keyword list. Return true if ok or false on error.

Reimplemented from ossimSource.

Reimplemented in ossimImageFileWriter, ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimGpkgWriter, ossimNitfWriterBase, ossimNitfWriter, ossimNitf20Writer, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimHistogramWriter, ossimGeneralRasterWriter, ossimGdalWriter, ossimKakaduNitfWriter, ossimImageWriter, ossimKakaduJp2Writer, ossimJpegWriter, and ossimArcInfoGridWriter.

Definition at line 5 of file ossimOutputSource.cpp.

References ossimSource::saveState().

Referenced by ossimImageWriter::saveState(), and ossimHistogramWriter::saveState().

 {
    return ossimSource::saveState(kwl, prefix);
 }

◆ setOutputName()

virtual void ossimOutputSource::setOutputName ( const ossimString & outputName )

inlinevirtual

This is a generic interface to allow one to set the output name of the writer. If its a Visual display this could be used to set the title. If this is a file output then this could be a directory or a file name.

Reimplemented in ossimImageFileWriter, ossimHistogramWriter, ossimVertexExtractor, and ossimImageDisplayWriter.

Definition at line 64 of file ossimOutputSource.h.

Referenced by ossimVertexExtractor::setOutputName(), ossimHistogramWriter::setOutputName(), and ossimImageFileWriter::setOutputName().

   {
     theOutputName = outputName;
   }

Member Data Documentation

◆ theOutputName

ossimString ossimOutputSource::theOutputName

protected

Definition at line 88 of file ossimOutputSource.h.

Referenced by ossimBitMaskWriter::close(), ossimBitMaskWriter::connectMyInputTo(), and ossimBitMaskWriter::loadState().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimOutputSource() [1/2]

◆ ossimOutputSource() [2/2]

◆ ~ossimOutputSource()

Member Function Documentation

◆ close()

◆ getOutputName()

◆ isOpen()

◆ loadState()

◆ open() [1/2]

◆ open() [2/2]

◆ saveState()

◆ setOutputName()

Member Data Documentation

◆ theOutputName