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

ossimGeomFileWriter More...

#include <ossimGeomFileWriter.h>

Inheritance diagram for ossimGeomFileWriter:
ossimMetadataFileWriter ossimConnectableObject ossimProcessInterface ossimConnectableObjectListener ossimObject ossimListenerManager ossimPropertyInterface ossimListener ossimReferenced

Public Member Functions

 ossimGeomFileWriter ()
 default constructor More...
 
virtual void getMetadatatypeList (std::vector< ossimString > &metadatatypeList) const
 Satisfies pure virtual from ossimMetadataWriter base. More...
 
virtual bool hasMetadataType (const ossimString &metadataType) const
 Satisfies pure virtual from ossimMetadataWriter base. More...
 
- Public Member Functions inherited from ossimMetadataFileWriter
 ossimMetadataFileWriter ()
 
virtual ossimObjectgetObject ()
 
virtual const ossimObjectgetObject () const
 
virtual void initialize ()
 
virtual bool execute ()
 
virtual void setPercentComplete (double percentComplete)
 
virtual void setFilename (const ossimFilename &file)
 
const ossimFilenamegetFilename () const
 
virtual bool loadState (const ossimKeywordlist &kwl, const char *prefix=0)
 Load state method: More...
 
bool canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
 required to be overriden by derived classes More...
 
virtual void disconnectInputEvent (ossimConnectionEvent &event)
 
virtual void connectInputEvent (ossimConnectionEvent &event)
 
virtual void propertyEvent (ossimPropertyEvent &event)
 
virtual void setPixelType (ossimPixelType pixelType)
 Ossim uses a concept of "pixel is point" internally. More...
 
virtual ossimPixelType getPixelType () const
 
virtual void setAreaOfInterest (const ossimIrect &areaOfInterest)
 Sets the area of interest to write the meta data for. More...
 
virtual ossimIrect getAreaOfInterest () const
 
virtual void setProperty (ossimRefPtr< ossimProperty > property)
 
virtual ossimRefPtr< ossimPropertygetProperty (const ossimString &name) const
 
virtual void getPropertyNames (std::vector< ossimString > &propertyNames) const
 
- 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 ossimIdgetId () const
 Will allow us to get this object's id. More...
 
const ossimObjectgetOwner () 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 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< ossimConnectableObjectdisconnectMyInput (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< ossimConnectableObjectdisconnectMyOutput (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...
 
ossimConnectableObjectgetInput (ossim_uint32 index=0)
 returns the object at the specified index. More...
 
const ossimConnectableObjectgetInput (ossim_uint32 index=0) const
 returns the object at the specified index. More...
 
ossimConnectableObjectgetOutput (ossim_uint32 index=0)
 returns the object at the specified index. More...
 
const ossimConnectableObjectgetOutput (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 ConnectableObjectListgetInputList () const
 
const ConnectableObjectListgetOutputList () const
 
ConnectableObjectListgetInputList ()
 
ConnectableObjectListgetOutputList ()
 
 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 bool saveState (ossimKeywordlist &kwl, const char *prefix=0) const
 
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 ossimObjectdup () 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 std::ostream & print (std::ostream &out) const
 Generic print method. More...
 
virtual bool isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) 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
 
- 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 ossimProcessInterface
 ossimProcessInterface ()
 
virtual ~ossimProcessInterface ()
 
virtual void abort ()
 
bool needsAborting () const
 
bool isAbortRequested () const
 
bool isAborted () const
 
bool isExecuting () const
 
ossimProcessStatus getProcessStatus () const
 
virtual void setProcessStatus (ossimProcessStatus processStatus)
 
virtual double getPercentComplete () const
 
virtual ossimListenerManagergetManager ()
 
void enableEvents ()
 
void disableEvents ()
 
void setCurrentMessage (const ossimString &message)
 
virtual std::ostream & print (std::ostream &out) const
 
- Public Member Functions inherited from ossimConnectableObjectListener
 ossimConnectableObjectListener ()
 
virtual ~ossimConnectableObjectListener ()
 
virtual void processEvent (ossimEvent &event)
 ProcessEvent. More...
 
virtual void objectDestructingEvent (ossimObjectDestructingEvent &)
 
virtual void connectionEvent (ossimConnectionEvent &)
 
virtual void disconnectOutputEvent (ossimConnectionEvent &)
 
virtual void connectOutputEvent (ossimConnectionEvent &)
 
virtual void addObjectEvent (ossimContainerEvent &)
 
virtual void removeObjectEvent (ossimContainerEvent &)
 
virtual void containerEvent (ossimContainerEvent &)
 
virtual void refreshEvent (ossimRefreshEvent &)
 
- Public Member Functions inherited from ossimListener
 ossimListener ()
 
virtual ~ossimListener ()
 
void enableListener ()
 
void disableListener ()
 
void setListenerEnableFlag (bool flag)
 
bool isListenerEnabled () const
 
bool getListenerEnableFlag () const
 

Protected Member Functions

virtual ~ossimGeomFileWriter ()
 virtual destructor More...
 
virtual bool writeFile ()
 Write a geometry file to "theFilename". More...
 
- Protected Member Functions inherited from ossimMetadataFileWriter
virtual ~ossimMetadataFileWriter ()
 
- Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObjectfindObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)
 
- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 
- Protected Member Functions inherited from ossimListenerManager
 ossimListenerManager (const ossimListenerManager &rhs)
 

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
 
- Public Types inherited from ossimProcessInterface
enum  ossimProcessStatus {
  PROCESS_STATUS_UNKNOWN = 0, PROCESS_STATUS_EXECUTING = 1, PROCESS_STATUS_ABORTED = 2, PROCESS_STATUS_ABORT_REQUEST = 3,
  PROCESS_STATUS_NOT_EXECUTING = 4
}
 
- Protected Attributes inherited from ossimMetadataFileWriter
ossimImageSourcetheInputConnection
 
ossimFilename theFilename
 
ossimPixelType thePixelType
 
ossimIrect theAreaOfInterest
 
- Protected Attributes inherited from ossimConnectableObject
ossimId theId
 
ossimString theDescription
 
ossimObjecttheOwner
 
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 ossimProcessInterface
double thePercentComplete
 
ossimProcessStatus theProcessStatus
 
ossimString theMessage
 
bool theEventFlag
 
- Protected Attributes inherited from ossimListener
bool theListenerEnableFlag
 

Detailed Description

ossimGeomFileWriter

Definition at line 19 of file ossimGeomFileWriter.h.

Constructor & Destructor Documentation

◆ ossimGeomFileWriter()

ossimGeomFileWriter::ossimGeomFileWriter ( )

default constructor

Definition at line 32 of file ossimGeomFileWriter.cpp.

◆ ~ossimGeomFileWriter()

ossimGeomFileWriter::~ossimGeomFileWriter ( )
protectedvirtual

virtual destructor

Definition at line 37 of file ossimGeomFileWriter.cpp.

38 {}

Member Function Documentation

◆ getMetadatatypeList()

void ossimGeomFileWriter::getMetadatatypeList ( std::vector< ossimString > &  metadatatypeList) const
virtual

Satisfies pure virtual from ossimMetadataWriter base.

Appends the writers image types to the "metadatatypeList".

Parameters
metadatatypeListstl::vector<ossimString> list to append to.
Note
Appends to the list, does not clear it first.

Implements ossimMetadataFileWriter.

Definition at line 123 of file ossimGeomFileWriter.cpp.

124 {
125  metadatatypeList.push_back(ossimString("ossim_geometry"));
126 }

◆ hasMetadataType()

bool ossimGeomFileWriter::hasMetadataType ( const ossimString metadataType) const
virtual

Satisfies pure virtual from ossimMetadataWriter base.

Parameters
imageTypestring representing image type.
Returns
true if "metadataType" is supported by writer.

Implements ossimMetadataFileWriter.

Definition at line 128 of file ossimGeomFileWriter.cpp.

130 {
131  return (metadataType == "ossim_geometry");
132 }

◆ writeFile()

bool ossimGeomFileWriter::writeFile ( )
protectedvirtual

Write a geometry file to "theFilename".

Implements ossimMetadataFileWriter.

Definition at line 40 of file ossimGeomFileWriter.cpp.

References ossimImageSource::getImageGeometry(), ossimImageGeometry::getImageSize(), ossimIpt::hasNans(), ossimIrect::size(), status, ossimMetadataFileWriter::theAreaOfInterest, ossimMetadataFileWriter::theInputConnection, and ossimRefPtr< T >::valid().

41 {
42  bool status = false;
44  {
46  if(geom.valid())
47  {
48  //---
49  // First check the ossimImageGeometry image size and adjust to area of interest if
50  // necessary. The ossimImageGeometry::applyScale method sometimes has rounding
51  // issues so fix it here...
52  //---
53  if ( geom->getImageSize().hasNans() ||
54  ( geom->getImageSize() != theAreaOfInterest.size() ) )
55  {
56  if ( traceDebug() )
57  {
59  << "ossimGeomFileWriter::writeFile DEBUG:"
60  << "\nAdjusting ossimImageGeometry size to reflect the area of interest."
61  << "\narea of interest size: " << theAreaOfInterest.size()
62  << "\nossimImageGeometry size: " << geom->getImageSize()
63  << std::endl;
64  }
66  }
67 
68  // Save the state to keyword list.
69  ossimKeywordlist kwl;
70  geom->saveState(kwl);
71 
72  const ossimMapProjection* mapProj =
74 
75  if (mapProj)
76  {
77  const char* prefix = "projection.";
78 
79  ossimDpt tiePoint;
80  if (mapProj->isGeographic())
81  {
82  // Get the ground tie point.
83  ossimGpt gpt;
84  mapProj->lineSampleToWorld(theAreaOfInterest.ul(), gpt);
85  tiePoint = gpt;
86 
87  // Set the units to degrees.
88  kwl.add(prefix,
90  ossimUnitTypeLut::instance()->getEntryString(OSSIM_DEGREES),
91  true);
92  }
93  else
94  {
95  // Get the easting northing tie point.
96  mapProj->lineSampleToEastingNorthing(theAreaOfInterest.ul(), tiePoint);
97 
98 
99  // Set the units to meters.
100  kwl.add(prefix,
102  ossimUnitTypeLut::instance()->getEntryString(OSSIM_METERS),
103  true);
104  }
105 
106  // Write the tie to keyword list.
107  kwl.add(prefix,
109  ossimDpt(tiePoint).toString().c_str(),
110  true);
111 
112  } // matches: if (mapProj)
113 
114  status = kwl.write(theFilename.c_str());
115 
116  } // matches: if(geom.valid())
117 
118  } // matches: if(theInputConnection)
119 
120  return status;
121 }
const ossimIpt & getImageSize() const
Represents serializable keyword/value map.
bool valid() const
Definition: ossimRefPtr.h:75
virtual bool isGeographic() const
const ossimIpt & ul() const
Definition: ossimIrect.h:274
void setImageSize(const ossimIpt &size)
virtual bool write(const char *file, const char *comment=0) const
Methods to dump the ossimKeywordlist to a file on disk.
ossimIpt size() const
Definition: ossimIrect.h:510
void add(const char *prefix, const ossimKeywordlist &kwl, bool overwrite=true)
virtual ossimGpt lineSampleToWorld(const ossimDpt &projectedPoint) const
static const char * TIE_POINT_XY_KW
virtual void lineSampleToEastingNorthing(const ossimDpt &liineSample, ossimDpt &eastingNorthing) const
#define PTR_CAST(T, p)
Definition: ossimRtti.h:321
virtual ossimRefPtr< ossimImageGeometry > getImageGeometry()
Returns the image geometry object associated with this tile source or NULL if not defined...
return status
const ossimProjection * getProjection() const
Access methods for projection (may be NULL pointer).
const char * c_str() const
Returns a pointer to a null-terminated array of characters representing the string&#39;s contents...
Definition: ossimString.h:396
virtual bool saveState(ossimKeywordlist &kwl, const char *prefix=0) const
Saves the transform (if any) and projection (if any) states to the KWL.
ossimImageSource * theInputConnection
bool hasNans() const
Definition: ossimIpt.h:58
static ossimUnitTypeLut * instance()
Returns the static instance of an ossimUnitTypeLut object.
OSSIMDLLEXPORT std::ostream & ossimNotify(ossimNotifyLevel level=ossimNotifyLevel_WARN)
static const char * TIE_POINT_UNITS_KW

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