App::PropertyFileIncluded Class Reference

File include properties This property doesn't only save the file name like PropertyFile it also includes the file itself into the document. More...

#include <PropertyFile.h>

Inheritance diagram for App::PropertyFileIncluded:
App::Property Base::Persistence Base::BaseClass

List of all members.

Public Member Functions

virtual Property * Copy (void) const
 Returns a new copy of the property (mainly for Undo/Redo and transactions).
std::string getDocTransientPath (void) const
virtual const char * getEditorName (void) const
 Get the class name of the associated property editor item.
std::string getExchangeTempFile (void) const
 get a temp file name in the transient path of the document.
virtual PyObject * getPyObject (void)
 This method returns the Python wrapper for a C++ object.
virtual Base::Type getTypeId (void) const
const char * getValue (void) const
virtual void Paste (const Property &from)
 PropertyFileIncluded (void)
virtual void Restore (Base::XMLReader &reader)
 This method is used to restore properties from an XML document.
virtual void RestoreDocFile (Base::Reader &reader)
 This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.
virtual void Save (Base::Writer &writer) const
 This method is used to save properties to an XML document.
virtual void SaveDocFile (Base::Writer &writer) const
 This method is used to save large amounts of data to a binary file.
virtual void setPyObject (PyObject *)
void setValue (const char *sFile, const char *sName=0)
virtual ~PropertyFileIncluded ()

Static Public Member Functions

static void * create (void)
static Base::Type getClassTypeId (void)
static void init (void)

Protected Attributes

std::string _BaseFileName
std::string _cValue

Detailed Description

File include properties This property doesn't only save the file name like PropertyFile it also includes the file itself into the document.

The file doesn't get loaded into memory, it gets copied from the document archive into the document transient directory. There it is accessible for the algorithms. You get the transient path through getDocTransientPath() It's allowed to read the file, it's not allowed to write the file directly in the transient path! That would undermine the Undo/Redo framework. It's only allowed to use setValue() to change the file. If you give a file name outside the transient dir to setValue() it will copy the file. If you give a file name in the transient path it will just rename and use the same file. You can use getExchangeTempFile() to get a file name in the transient dir to write a new file version.

Definition at line 74 of file PropertyFile.h.

Constructor & Destructor Documentation

PropertyFileIncluded::PropertyFileIncluded ( void   ) 

Definition at line 56 of file PropertyFile.cpp.

Referenced by Copy().

PropertyFileIncluded::~PropertyFileIncluded (  )  [virtual]

Definition at line 61 of file PropertyFile.cpp.

References _cValue, and DrawingExample::file.

Member Function Documentation

Property * PropertyFileIncluded::Copy ( void   )  const [virtual]

Returns a new copy of the property (mainly for Undo/Redo and transactions).

Implements App::Property.

Definition at line 329 of file PropertyFile.cpp.

References _BaseFileName, _cValue, Base::Console(), Base::FileInfo::deleteFile(), Base::FileInfo::dirPath(), DrawingExample::file, Base::FileInfo::fileName(), Base::FileInfo::filePath(), Base::FileInfo::getTempFileName(), Base::ConsoleSingleton::Log(), draftTools::p, PropertyFileIncluded(), and Base::FileInfo::renameFile().

void * App::PropertyFileIncluded::create ( void   )  [static]

Reimplemented from App::Property.

Definition at line 54 of file PropertyFile.cpp.

Base::Type App::PropertyFileIncluded::getClassTypeId ( void   )  [static]

Reimplemented from App::Property.

Definition at line 54 of file PropertyFile.cpp.

Referenced by Gui::PropertyEditor::PropertyTransientFileItem::value().

std::string PropertyFileIncluded::getDocTransientPath ( void   )  const

Definition at line 70 of file PropertyFile.cpp.

References App::PropertyContainer::getClassTypeId(), App::Property::getContainer(), and Base::BaseClass::isDerivedFrom().

Referenced by getExchangeTempFile(), Restore(), and setValue().

virtual const char* App::PropertyFileIncluded::getEditorName ( void   )  const [inline, virtual]

Get the class name of the associated property editor item.

Reimplemented from App::Property.

Definition at line 85 of file PropertyFile.h.

std::string PropertyFileIncluded::getExchangeTempFile ( void   )  const

get a temp file name in the transient path of the document.

Using this file for new Version of the file and set this file with setValue() is the fastest way to change the File.

Definition at line 79 of file PropertyFile.cpp.

References getDocTransientPath(), Base::FileInfo::getTempFileName(), and getValue().

Referenced by Raytracing::RayProject::execute(), and Drawing::FeaturePage::execute().

PyObject * PropertyFileIncluded::getPyObject ( void   )  [virtual]

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Base::BaseClass.

Definition at line 180 of file PropertyFile.cpp.

References _cValue, and draftTools::p.

Base::Type App::PropertyFileIncluded::getTypeId ( void   )  const [virtual]

Reimplemented from App::Property.

Definition at line 54 of file PropertyFile.cpp.

const char * PropertyFileIncluded::getValue ( void   )  const

Definition at line 175 of file PropertyFile.cpp.

References _cValue.

Referenced by Gui::Dialog::DlgEditFileIncludePropertyExternal::Do(), Raytracing::RayProject::execute(), Drawing::FeaturePage::execute(), getExchangeTempFile(), Robot::RobotObject::onChanged(), Drawing::FeaturePage::onChanged(), RobotGui::ViewProviderRobotObject::updateData(), and ImageGui::ViewProviderImagePlane::updateData().

void App::PropertyFileIncluded::init ( void   )  [static]

Reimplemented from App::Property.

Definition at line 54 of file PropertyFile.cpp.

void PropertyFileIncluded::Paste ( const Property &  from  )  [virtual]

Definition at line 353 of file PropertyFile.cpp.

References _BaseFileName, _cValue, App::Property::aboutToSetValue(), Base::FileInfo::deleteFile(), Base::FileInfo::dirPath(), DrawingExample::file, App::Property::hasSetValue(), and Base::FileInfo::renameFile().

void PropertyFileIncluded::Restore ( Base::XMLReader &   )  [virtual]

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example: 

 void PropertyVector::Restore(Base::XMLReader &reader)
 {
   // read my Element
   reader.readElement("PropertyVector");
   // get the value of my Attribute
   _cVec.x = (float)reader.getAttributeAsFloat("valueX");
   _cVec.y = (float)reader.getAttributeAsFloat("valueY");
   _cVec.z = (float)reader.getAttributeAsFloat("valueZ");
 }

Implements Base::Persistence.

Definition at line 280 of file PropertyFile.cpp.

References _BaseFileName, _cValue, App::Property::aboutToSetValue(), Base::XMLReader::addFile(), DrawingExample::file, Base::XMLReader::getAttribute(), getDocTransientPath(), App::Property::hasSetValue(), and Base::XMLReader::readElement().

void PropertyFileIncluded::RestoreDocFile ( Base::Reader &   )  [virtual]

This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.

Again you have to apply for the call of this method in the Restore() call: 

 void PropertyMeshKernel::Restore(Base::XMLReader &reader)
 {
   reader.readElement("Mesh");
   std::string file (reader.getAttribute("file") );
 
   if(file == "")
   {
     // read XML
     MeshCore::MeshDocXML restorer(*_pcMesh);
     restorer.Restore(reader);
   }else{
     // initate a file read
     reader.addFile(file.c_str(),this);
  }
 }

After you issued the reader.addFile() your RestoreDocFile() is called: 

 void PropertyMeshKernel::RestoreDocFile(Base::Reader &reader)
 {
     _pcMesh->Read( reader );
 }
See also:
Base::Reader,Base::XMLReader

Reimplemented from Base::Persistence.

Definition at line 312 of file PropertyFile.cpp.

References _cValue, App::Property::aboutToSetValue(), and App::Property::hasSetValue().

void PropertyFileIncluded::Save ( Base::Writer &   )  const [virtual]

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector: 

  void PropertyVector::Save (Writer &writer) const
  {
     writer << writer.ind() << "<PropertyVector valueX=\"" <<  _cVec.x <<
                                            "\" valueY=\"" <<  _cVec.y <<
                                            "\" valueZ=\"" <<  _cVec.z <<"\"/>" << endl;
  }

The writer.ind() expression writes the indention, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.

See also:
Base::Writer

Implements Base::Persistence.

Definition at line 257 of file PropertyFile.cpp.

References _cValue, Base::Writer::addFile(), DrawingExample::file, Base::Writer::ind(), Base::Writer::insertBinFile(), Base::Writer::isForceXML(), and Base::Writer::Stream().

void PropertyFileIncluded::SaveDocFile ( Base::Writer &   )  const [virtual]

This method is used to save large amounts of data to a binary file.

Sometimes it makes no sense to write property data as XML. In case the amount of data is too big or the data type has a more effective way to save itself. In this cases it is possible to write the data in a seperate file inside the document archive. In case you want do so you have to re-implement SaveDocFile(). First, you have to inform the framework in Save() that you want do so. Here an example from the Mesh module which can save a (pontetionaly big) triangle mesh: 

 void PropertyMeshKernel::Save (Base::Writer &writer) const
 {
   if (writer.isForceXML())
   {
     writer << writer.ind() << "<Mesh>" << std::endl;
     MeshCore::MeshDocXML saver(*_pcMesh);
     saver.Save(writer);
   }else{
    writer << writer.ind() << "<Mesh file=\"" << writer.addFile("MeshKernel.bms", this) << "\"/>" << std::endl;
 }

The writer.isForceXML() is an indication to force you to write XML. Regardless of size and effectivness. The second part informs the Base::writer through writer.addFile("MeshKernel.bms", this) that this object wants to write a file with the given name. The method addFile() returns a unique name that then is written in the XML stream. This allows your RestoreDocFile() method to identify and read the file again. Later your SaveDocFile() method is called as many times as you issued the addFile() call: 

 void PropertyMeshKernel::SaveDocFile (Base::Writer &writer) const
 {
     _pcMesh->Write( writer );
 }

In this method you can simply stream your content to the file (Base::Writer inheriting from ostream).

Reimplemented from Base::Persistence.

Definition at line 297 of file PropertyFile.cpp.

References _cValue, and Base::Writer::Stream().

void PropertyFileIncluded::setPyObject ( PyObject *  value  )  [virtual]

Reimplemented from Base::BaseClass.

Definition at line 187 of file PropertyFile.cpp.

References draftlibs::dxfReader::error(), DrawingExample::file, and setValue().

void PropertyFileIncluded::setValue ( const char *  sFile,
const char *  sName = 0 
)

Definition at line 85 of file PropertyFile.cpp.

References _BaseFileName, _cValue, App::Property::aboutToSetValue(), Base::FileInfo::copyTo(), Base::FileInfo::deleteFile(), Base::FileInfo::dirPath(), Base::FileInfo::exists(), Mesh2Shape::ext, Base::FileInfo::extension(), DrawingExample::file, Base::FileInfo::fileName(), Base::FileInfo::fileNamePure(), Base::FileInfo::filePath(), getDocTransientPath(), Base::FileInfo::getTempFileName(), App::Property::hasSetValue(), Base::FileInfo::renameFile(), Base::FileInfo::setFile(), and Py::value().

Referenced by Gui::Dialog::DlgEditFileIncludePropertyExternal::Do(), Raytracing::RayProject::execute(), Drawing::FeaturePage::execute(), insert(), and setPyObject().

Member Data Documentation

std::string App::PropertyFileIncluded::_BaseFileName [protected]

Definition at line 111 of file PropertyFile.h.

Referenced by Copy(), Paste(), Restore(), and setValue().

std::string App::PropertyFileIncluded::_cValue [protected]

Definition at line 110 of file PropertyFile.h.

Referenced by Copy(), getPyObject(), getValue(), Paste(), Restore(), RestoreDocFile(), Save(), SaveDocFile(), setValue(), and ~PropertyFileIncluded().

The documentation for this class was generated from the following files:
Generated on Wed Nov 23 19:01:44 2011 for FreeCAD by  doxygen 1.6.1