|
OSSIM - Open Source Software Image Map
Version 1.9.0 (20180803)
|
Class to write out meta data in a Federal Geographic Data Committe (FGDC) format. More...
#include <ossimFgdcFileWriter.h>
Public Member Functions | |
| ossimFgdcFileWriter () | |
| constructor More... | |
| virtual bool | loadState (const ossimKeywordlist &kwl, const char *prefix=0) |
| Method to load the state from a keyword list. 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... | |
| ossim_uint32 | getIndentionLevel () const |
| void | setIndentionLevel (ossim_uint32 level) |
| Sets the current indentation level. More... | |
| ossimString | getTabString () const |
| void | setTabString (const ossimString &tabString) |
| Sets the tab string. More... | |
| void | setTitle (const ossimString &pubDate) |
| void | setTemplate (const ossimFilename &xmlTemplateFile) |
| ossimString | find (const ossimString &xpath) const |
| bool | writeTemplate (const ossimFilename &file) const |
Public Member Functions inherited from ossimMetadataFileWriter | |
| ossimMetadataFileWriter () | |
| virtual ossimObject * | getObject () |
| virtual const ossimObject * | getObject () const |
| virtual void | initialize () |
| virtual bool | execute () |
| virtual void | setPercentComplete (double percentComplete) |
| virtual void | setFilename (const ossimFilename &file) |
| const ossimFilename & | getFilename () const |
| 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< ossimProperty > | getProperty (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 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 | 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 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 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 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 &) | |
| 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 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 ossimListenerManager * | getManager () |
| 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 | ~ossimFgdcFileWriter () |
| destructor More... | |
| virtual bool | writeFile () |
| Writes file to disk. More... | |
Protected Member Functions inherited from ossimMetadataFileWriter | |
| virtual | ~ossimMetadataFileWriter () |
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) | |
Private Member Functions | |
| void | openTag (std::ostream &os, const ossimString &tag, bool newLine) const |
| Writes openning tag adding any indentation and brackets. More... | |
| void | closeTag (std::ostream &os, const ossimString &tag, bool decrementLevel) const |
| Closes tag decrementing indentation. More... | |
Private Attributes | |
| ossim_uint32 | theIndentionLevel |
| ossimString | theTabString |
| ossimXmlDocument | theTemplate |
| ossimFilename | theSourceImageFilename |
Class to write out meta data in a Federal Geographic Data Committe (FGDC) format.
Definition at line 26 of file ossimFgdcFileWriter.h.
| ossimFgdcFileWriter::ossimFgdcFileWriter | ( | ) |
constructor
Definition at line 35 of file ossimFgdcFileWriter.cpp.
|
protectedvirtual |
|
private |
Closes tag decrementing indentation.
e.g.: <metadata>
| os | otream to write to. |
| tag | String representing tag with no brackets. |
| decrementLevel | If true indentation level is decremented. |
Definition at line 895 of file ossimFgdcFileWriter.cpp.
References ossimString::c_str(), ossimString::size(), theIndentionLevel, and theTabString.
Referenced by writeFile(), and writeTemplate().
| ossimString ossimFgdcFileWriter::find | ( | const ossimString & | xpath | ) | const |
Definition at line 923 of file ossimFgdcFileWriter.cpp.
References ossimXmlDocument::findNodes(), ossimErrorStatusInterface::getErrorStatus(), and theTemplate.
Referenced by writeFile().
| ossim_uint32 ossimFgdcFileWriter::getIndentionLevel | ( | ) | const |
Definition at line 851 of file ossimFgdcFileWriter.cpp.
References theIndentionLevel.
|
virtual |
Satisfies pure virtual from ossimMetadataWriter base.
Appends the writers image types to the "metadatatypeList".
| metadatatypeList | stl::vector<ossimString> list to append to. |
Implements ossimMetadataFileWriter.
Definition at line 945 of file ossimFgdcFileWriter.cpp.
| ossimString ossimFgdcFileWriter::getTabString | ( | ) | const |
Definition at line 861 of file ossimFgdcFileWriter.cpp.
References theTabString.
|
virtual |
Satisfies pure virtual from ossimMetadataWriter base.
| imageType | string representing image type. |
Implements ossimMetadataFileWriter.
Definition at line 951 of file ossimFgdcFileWriter.cpp.
|
virtual |
Method to load the state from a keyword list.
| kwl | Keyword list to load state from. |
| prefix | Prefix to attatch to keyword (like "object1."). default=NULL |
Keywords picked up by this loadState:
source_image_filename: foo.ntf tab_string: "\t" fgdc_template_doc: fgdc_template.xml
Reimplemented from ossimMetadataFileWriter.
Definition at line 824 of file ossimFgdcFileWriter.cpp.
References ossimKeywordlist::find(), ossimMetadataFileWriter::loadState(), setTemplate(), theSourceImageFilename, and theTabString.
|
private |
Writes openning tag adding any indentation and brackets.
Increments indentation level.
| os | otream to write to. |
| tag | String representing tag with no brackets, i.e. "metadata". |
| newLine | If true a new line "\n" is added. |
Definition at line 871 of file ossimFgdcFileWriter.cpp.
References ossimString::c_str(), ossimString::size(), theIndentionLevel, and theTabString.
Referenced by writeFile(), and writeTemplate().
| void ossimFgdcFileWriter::setIndentionLevel | ( | ossim_uint32 | level | ) |
Sets the current indentation level.
| level | Indentation level. "0" equals no indentation. |
Definition at line 856 of file ossimFgdcFileWriter.cpp.
References theIndentionLevel.
| void ossimFgdcFileWriter::setTabString | ( | const ossimString & | tabString | ) |
Sets the tab string.
Usually "\t" or spaces " ".
| tabString | String to use for indentation. |
Definition at line 866 of file ossimFgdcFileWriter.cpp.
References theTabString.
| void ossimFgdcFileWriter::setTemplate | ( | const ossimFilename & | xmlTemplateFile | ) |
Definition at line 918 of file ossimFgdcFileWriter.cpp.
References ossimXmlDocument::openFile(), and theTemplate.
Referenced by loadState().
| void ossimFgdcFileWriter::setTitle | ( | const ossimString & | pubDate | ) |
| title | Tile of data usually the image file name. |
|
protectedvirtual |
Writes file to disk.
Implements ossimMetadataFileWriter.
Definition at line 48 of file ossimFgdcFileWriter.cpp.
References ossimString::c_str(), closeTag(), find(), ossimImageSource::getBoundingRect(), ossimImageSource::getImageGeometry(), ossimImageGeometry::getProjection(), ossimMapProjection::isGeographic(), ossimFilename::NIL, openTag(), ossimNotify(), ossimNotifyLevel_WARN, PTR_CAST, ossimMetadataFileWriter::theFilename, ossimMetadataFileWriter::theInputConnection, theSourceImageFilename, ossimString::toString(), and ossimRefPtr< T >::valid().
| bool ossimFgdcFileWriter::writeTemplate | ( | const ossimFilename & | file | ) | const |
Definition at line 491 of file ossimFgdcFileWriter.cpp.
References ossimString::c_str(), closeTag(), openTag(), ossimNotify(), and ossimNotifyLevel_WARN.
|
mutableprivate |
Definition at line 149 of file ossimFgdcFileWriter.h.
Referenced by closeTag(), getIndentionLevel(), openTag(), and setIndentionLevel().
|
private |
Definition at line 152 of file ossimFgdcFileWriter.h.
Referenced by loadState(), and writeFile().
|
private |
Definition at line 150 of file ossimFgdcFileWriter.h.
Referenced by closeTag(), getTabString(), loadState(), openTag(), and setTabString().
|
private |
Definition at line 151 of file ossimFgdcFileWriter.h.
Referenced by find(), and setTemplate().
1.8.14