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>

Public Member Functions
virtual Property *	Copy (void) const
	Returns a new copy of the property (mainly for Undo/Redo and transactions) More...

virtual const char *	getEditorName (void) const
	Get the class name of the associated property editor item. More...

std::string	getExchangeTempFile (void) const
	get a temp file name in the transient path of the document. More...

virtual unsigned int	getMemSize (void) const
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? This method is defined in Base::Persistence. More...

std::string	getOriginalFileName (void) const

virtual PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object. More...

const char *	getValue (void) const

bool	isEmpty (void) const

virtual void	Paste (const Property &from)
	Paste the value from the property (mainly for Undo/Redo and transactions) More...

	PropertyFileIncluded (void)

virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...

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 SaveDocFile() saved data. More...

virtual void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document. More...

virtual void	SaveDocFile (Base::Writer &writer) const
	This method is used to save large amounts of data to a binary file. More...

virtual void	setPyObject (PyObject *)

void	setValue (const char sFile, const char sName=0)

virtual	~PropertyFileIncluded ()

Public Member Functions inherited from App::Property
virtual void	aboutToSetChildValue (Property &)
	Called before a child property changing value. More...

virtual void	afterRestore ()
	Called at the beginning of Document::afterRestore() More...

virtual App::ObjectIdentifier	canonicalPath (const App::ObjectIdentifier &p) const
	Convert p to a canonical representation of it. More...

PropertyContainer *	getContainer (void) const
	Get a pointer to the PropertyContainer derived class the property belongs to. More...

const char *	getDocumentation (void) const
	Get the documentation of this property. More...

std::string	getFullName () const

const char *	getGroup (void) const
	Get the group of this property. More...

const char *	getName (void) const
	get the name of this property in the belonging container More...

virtual void	getPaths (std::vector< App::ObjectIdentifier > &paths) const
	Get valid paths for this property; used by auto completer. More...

virtual const boost::any	getPathValue (const App::ObjectIdentifier &path) const
	Get value of property. More...

virtual bool	getPyPathValue (const App::ObjectIdentifier &, Py::Object &) const
	Get Python value of property. More...

unsigned long	getStatus () const
	return the status bits More...

short	getType (void) const
	Get the type of the property in the container. More...

virtual void	hasSetChildValue (Property &)
	Called when a child property has changed value. More...

bool	isReadOnly () const

bool	isSinglePrecision () const
	Gets precision of properties using floating point numbers. More...

bool	isTouched (void) const
	Test if this property is touched. More...

virtual void	onContainerRestored ()
	Called before calling DocumentObject::onDocumentRestored() More...

	Property ()

void	purgeTouched (void)
	Reset this property touched. More...

void	setContainer (PropertyContainer *Father)
	Is called by the framework to set the father (container) More...

virtual void	setPathValue (const App::ObjectIdentifier &path, const boost::any &value)
	Set value of property. More...

void	setReadOnly (bool readOnly)
	Sets property editable/grayed out in property editor. More...

void	setSinglePrecision (bool single)
	Sets precision of properties using floating point numbers to single, the default is double. More...

void	setStatus (Status pos, bool on)

void	setStatusValue (unsigned long status)

bool	testStatus (Status pos) const

void	touch ()
	Property status handling. More...

virtual	~Property ()

Public Member Functions inherited from Base::Persistence
void	dumpToStream (std::ostream &stream, int compression)

virtual Base::Type	getTypeId (void) const

void	restoreFromStream (std::istream &stream)

Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...

bool	isDerivedFrom (const Type type) const

virtual	~BaseClass ()
	Destruction. More...

Protected Member Functions
void	aboutToSetValue (void)
	Gets called by all setValue() methods before the value has changed. More...

std::string	getDocTransientPath (void) const

std::string	getUniqueFileName (const std::string &, const std::string &) const

Protected Member Functions inherited from App::Property
virtual void	hasSetValue (void)
	Gets called by all setValue() methods after the value has changed. More...

virtual void	verifyPath (const App::ObjectIdentifier &p) const
	Verify a path for the current property. More...

Additional Inherited Members
Public Types inherited from App::Property
enum	Status { Touched = 0, Immutable = 1, ReadOnly = 2, Hidden = 3, Transient = 4, MaterialEdit = 5, NoMaterialListEdit = 6, Output = 7, LockDynamic = 8, NoModify = 9, PartialTrigger = 10, NoRecompute = 11, Single = 12, Ordered = 13, EvalOnRestore = 14, PropStaticBegin = 21, PropDynamic = 21, PropNoPersist = 22, PropNoRecompute = 23, PropReadOnly = 24, PropTransient = 25, PropHidden = 26, PropOutput = 27, PropStaticEnd = 28, User1 = 28, User2 = 29, User3 = 30, User4 = 31 }

Static Public Member Functions inherited from App::Property
static void	destroy (Property *p)
	For safe deleting of a dynamic property. More...

Static Public Member Functions inherited from Base::Persistence
static void *	create (void)

static std::string	encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...

static Base::Type	getClassTypeId (void)

static void	init (void)

Static Public Member Functions inherited from Base::BaseClass
static void *	create (void)

static Type	getClassTypeId (void)

static void	init (void)

Static Protected Member Functions inherited from Base::BaseClass
static void	initSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Type::instantiationMethod method=nullptr)

Protected Attributes inherited from App::Property
std::bitset< 32 >	StatusBits
	Status bits of the property The first 8 bits are used for the base system the rest can be used in descendent classes to mark special statuses on the objects. More...

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.

Constructor & Destructor Documentation

◆ PropertyFileIncluded()

PropertyFileIncluded::PropertyFileIncluded ( void )

◆ ~PropertyFileIncluded()

PropertyFileIncluded::~PropertyFileIncluded ( )

virtual

References Base::FileInfo::ReadWrite.

Member Function Documentation

◆ aboutToSetValue()

void PropertyFileIncluded::aboutToSetValue ( void )

protectedvirtual

Gets called by all setValue() methods before the value has changed.

Reimplemented from App::Property.

References App::Property::aboutToSetValue().

◆ Copy()

Property * PropertyFileIncluded::Copy ( void ) const

virtual

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

Implements App::Property.

References Base::Console(), Base::FileInfo::filePath(), Base::ConsoleSingleton::Log(), Base::FileInfo::ReadWrite, and Base::FileInfo::setPermissions().

◆ getDocTransientPath()

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

protected

References Base::Persistence::getClassTypeId(), and Base::BaseClass::isDerivedFrom().

◆ getEditorName()

virtual const char* App::PropertyFileIncluded::getEditorName ( void ) const

virtual

Get the class name of the associated property editor item.

Reimplemented from App::Property.

◆ getExchangeTempFile()

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.

References Base::FileInfo::getTempFileName().

Referenced by Drawing::FeaturePage::execute(), TechDraw::DrawTileWeld::replaceSymbolIncluded(), and TechDraw::DrawTileWeld::setupSymbolIncluded().

◆ getMemSize()

unsigned int PropertyFileIncluded::getMemSize ( void ) const

virtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? This method is defined in Base::Persistence.

See also: Base::Persistence

Reimplemented from App::Property.

References App::Property::getMemSize().

◆ getOriginalFileName()

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

Referenced by App::VRMLObject::onChanged().

◆ getPyObject()

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.

◆ getUniqueFileName()

std::string PropertyFileIncluded::getUniqueFileName	(	const std::string &	path,
		const std::string &	filename
	)		const

protected

References Base::FileInfo::exists(), Base::FileInfo::filePath(), Base::Uuid::getValue(), and Base::FileInfo::setFile().

◆ getValue()

const char * PropertyFileIncluded::getValue ( void ) const

Referenced by TechDrawGui::QGISVGTemplate::createClickHandles(), Gui::Dialog::DlgEditFileIncludePropertyExternal::Do(), TechDrawGui::QGISVGTemplate::draw(), TechDrawGui::QGIViewPart::drawViewPart(), Drawing::FeaturePage::execute(), Drawing::FeaturePage::onChanged(), Drawing::FeaturePage::onDocumentRestored(), TechDrawGui::QGVPage::postProcessXml(), App::VRMLObject::RestoreDocFile(), TechDraw::DrawTileWeld::setupSymbolIncluded(), Gui::ViewProviderVRMLObject::updateData(), ImageGui::ViewProviderImagePlane::updateData(), and RobotGui::ViewProviderRobotObject::updateData().

◆ isEmpty()

bool App::PropertyFileIncluded::isEmpty ( void ) const

Referenced by TechDrawGui::QGIViewPart::drawViewPart(), TechDraw::DrawTileWeld::onDocumentRestored(), and TechDraw::DrawTileWeld::replaceSymbolIncluded().

◆ Paste()

void PropertyFileIncluded::Paste ( const Property & from )

virtual

Paste the value from the property (mainly for Undo/Redo and transactions)

Implements App::Property.

References Base::FileInfo::copyTo(), Base::FileInfo::deleteFile(), Base::FileInfo::dirPath(), Base::FileInfo::exists(), Base::FileInfo::fileName(), Base::FileInfo::filePath(), Base::FileInfo::ReadOnly, Base::FileInfo::ReadWrite, Base::FileInfo::renameFile(), Base::FileInfo::setFile(), and Base::FileInfo::setPermissions().

◆ Restore()

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 = reader.getAttributeAsFloat("valueX");
  _cVec.y = reader.getAttributeAsFloat("valueY");
  _cVec.z = reader.getAttributeAsFloat("valueZ");
}

Implements Base::Persistence.

References Base::XMLReader::addFile(), Base::XMLReader::getAttribute(), Base::XMLReader::hasAttribute(), Base::XMLReader::readBinFile(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), Base::FileInfo::ReadOnly, and Base::FileInfo::setPermissions().

◆ RestoreDocFile()

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 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{
    // initiate 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.

References Base::FileInfo::exists(), Base::FileInfo::isWritable(), Base::FileInfo::ReadOnly, and Base::FileInfo::setPermissions().

◆ Save()

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 indentation, 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.

References Base::Writer::addFile(), Base::Writer::decInd(), Base::FileInfo::exists(), Base::FileInfo::filePath(), Base::Writer::incInd(), Base::Writer::ind(), Base::Writer::insertBinFile(), Base::Writer::isForceXML(), and Base::Writer::Stream().

◆ SaveDocFile()

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 separate 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 effectiveness. 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.

References Base::Writer::Stream().

◆ setPyObject()

void PropertyFileIncluded::setPyObject ( PyObject * value )

virtual

Reimplemented from Base::BaseClass.

◆ setValue()

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

References Base::FileInfo::dirPath(), Base::FileInfo::exists(), Base::FileInfo::extension(), Base::FileInfo::fileName(), Base::FileInfo::fileNamePure(), Base::FileInfo::filePath(), Base::FileInfo::ReadOnly, Base::FileInfo::ReadWrite, and Base::FileInfo::setFile().

Referenced by Gui::Dialog::DlgEditFileIncludePropertyExternal::Do(), Drawing::FeaturePage::execute(), TechDraw::DrawTileWeld::replaceSymbolIncluded(), and TechDraw::DrawTileWeld::setupSymbolIncluded().

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

src/App/PropertyFile.h
src/App/PropertyFile.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PropertyFileIncluded()

◆ ~PropertyFileIncluded()

Member Function Documentation

◆ aboutToSetValue()

◆ Copy()

◆ getDocTransientPath()

◆ getEditorName()

◆ getExchangeTempFile()

◆ getMemSize()

◆ getOriginalFileName()

◆ getPyObject()

◆ getUniqueFileName()

◆ getValue()

◆ isEmpty()

◆ Paste()

◆ Restore()

◆ RestoreDocFile()

◆ Save()

◆ SaveDocFile()

◆ setPyObject()

◆ setValue()