#include <PropertyLinks.h>

Public Member Functions
virtual bool	adjustLink (const std::set< App::DocumentObject * > &inList) override
	Called to adjust the link to avoid potential cyclic dependency. More...

virtual void	breakLink (App::DocumentObject *obj, bool clear) override
	Called to reset this link property. More...

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

virtual Property *	CopyOnLinkReplace (const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject *newObj) const override
	Return a copy of the property if the link replacement affects this property. More...

DocumentObject *	find (const char sub, int pindex=0) const

DocumentObject *	find (const std::string &, int *pindex=0) const

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

virtual void	getLinks (std::vector< App::DocumentObject * > &objs, bool all=false, std::vector< std::string > *subs=0, bool newStyle=true) const override
	Obtain the linked objects. More...

virtual unsigned int	getMemSize (void) const override
	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...

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

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

	PropertyLinkList ()
	A constructor. More...

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

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

void	set1Value (int idx, DocumentObject *const &value) override

virtual void	setSize (int newSize) override

virtual void	setSize (int newSize, const_reference def) override

void	setValues (const std::vector< DocumentObject * > &) override
	Sets the property. More...

virtual	~PropertyLinkList ()
	A destructor. More...

Public Member Functions inherited from App::PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase >
virtual int	getSize (void) const override

const std::vector< DocumentObject * > &	getValue (void) const

const std::vector< DocumentObject * > &	getValues (void) const

const_reference	operator[] (int idx) const

virtual void	set1Value (int index, const_reference value)

virtual void	setPyObject (PyObject *value) override

void	setValue (const std::vector< DocumentObject * > &newValues=std::vector< DocumentObject * >())

void	setValue (const_reference value)

Public Member Functions inherited from App::PropertyLinkBase
void	checkLabelReferences (const std::vector< std::string > &subs, bool reset=true)
	Check subnames for label registration. More...

virtual int	checkRestore (std::string *msg=0) const
	Test if the link is restored unchanged. More...

virtual Property *	CopyOnImportExternal (const std::map< std::string, std::string > &nameMap) const
	Return a copy of the property if any changes caused by importing external linked object. More...

virtual Property *	CopyOnLabelChange (App::DocumentObject obj, const std::string &ref, const char newLabel) const
	Update object label reference in this property. More...

void	getLinkedElements (std::map< App::DocumentObject *, std::vector< std::string > > &elements, bool newStyle=true, bool all=true) const
	Helper function to return a map of linked object and its subname references. More...

template<class T >
void	getLinkedObjects (T &inserter, bool all=false) const
	Helper function to return linked objects using an std::inserter. More...

std::map< App::DocumentObject *, std::vector< std::string > >	linkedElements (bool newStyle=true, bool all=true) const
	Helper function to return a map of linked object and its subname references. More...

std::vector< App::DocumentObject * >	linkedObjects (bool all=false) const
	Helper function to return all linked objects of this property. More...

	PropertyLinkBase ()

virtual bool	referenceChanged () const
	Test if the element reference has changed after restore. More...

void	registerLabelReferences (std::vector< std::string > &&labels, bool reset=true)
	Register label reference for future object relabel update. More...

void	setAllowExternal (bool allow)
	Enable/disable temporary holding external object without throwing exception. More...

virtual void	setAllowPartial (bool enable)

bool	testFlag (int flag) const

void	unregisterElementReference ()
	Clear internal element reference registration. More...

void	unregisterLabelReferences ()
	Clear internal label references registration. More...

virtual void	updateElementReference (App::DocumentObject *feature, bool reverse=false, bool notify=false)
	Link type property interface APIs These APIs are moved here so that any type of property can have the property link behavior, e.g. More...

virtual	~PropertyLinkBase ()

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

virtual void	RestoreDocFile (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...

void	restoreFromStream (std::istream &stream)

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

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

bool	isDerivedFrom (const Type type) const

virtual	~BaseClass ()
	Destruction. More...

Public Member Functions inherited from App::ScopedLink
LinkScope	getScope ()
	Get the links scope Retrieve what kind of links are allowed. More...

void	setScope (LinkScope scope)
	Set the links scope Allows to define what kind of links are allowed. More...

Public Member Functions inherited from App::PropertyListsBase
void	clearTouchList ()

const std::set< int > &	getTouchList () const

Protected Member Functions
DocumentObject *	getPyValue (PyObject *item) const override

Protected Member Functions inherited from App::PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase >
void	setPyValues (const std::vector< PyObject * > &vals, const std::vector< int > &indices) override

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

void	setFlag (int flag, bool value=true)

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

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

Protected Member Functions inherited from App::AtomicPropertyChangeInterface< PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase > >
	AtomicPropertyChangeInterface ()

Additional Inherited Members
Public Types inherited from App::PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase >
typedef AtomicPropertyChangeInterface< PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase > >::AtomicPropertyChange	atomic_change

typedef std::vector< DocumentObject * > ::const_reference	const_reference

typedef std::vector< DocumentObject * >	list_type

typedef PropertyLinkListBase	parent_type

Public Types inherited from App::PropertyLinkBase
enum	LinkFlags { LinkAllowExternal, LinkDetached, LinkRestoring, LinkAllowPartial, LinkRestoreLabel }

typedef std::pair< std::string, std::string >	ShadowSub

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::PropertyLinkBase
static void	breakLinks (App::DocumentObject link, const std::vector< App::DocumentObject > &objs, bool clear)
	Helper function for breaking link properties. More...

static const char *	exportSubName (std::string &output, const App::DocumentObject obj, const char subname, bool first_obj=false)
	Helper function to export a subname reference. More...

static void	getLabelReferences (std::vector< std::string > &labels, const char *subname)
	Helper function to extract labels from a subname reference. More...

static std::string	importSubName (Base::XMLReader &reader, const char *sub, bool &restoreLabel)
	Helper function to import a subname reference. More...

static void	restoreLabelReference (const App::DocumentObject obj, std::string &sub, ShadowSub shadow=0)
	Helper function to restore label references during import. More...

static App::DocumentObject *	tryImport (const App::Document doc, const App::DocumentObject obj, const std::map< std::string, std::string > &nameMap)
	Helper function for link import operation. More...

static std::string	tryImportSubName (const App::DocumentObject obj, const char sub, const App::Document *doc, const std::map< std::string, std::string > &nameMap)
	Helper function for link import operation. More...

static std::pair< App::DocumentObject *, std::string >	tryReplaceLink (const App::PropertyContainer owner, App::DocumentObject obj, const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject newObj, const char sub=0)
	Helper functions. More...

static std::pair< App::DocumentObject *, std::vector< std::string > >	tryReplaceLinkSubs (const App::PropertyContainer owner, App::DocumentObject obj, const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject *newObj, const std::vector< std::string > &subs)
	Helper function to check and replace a link with multiple subname references. More...

static void	updateElementReferences (DocumentObject *feature, bool reverse=false)
	Update all element references in all link properties of feature. More...

static std::string	updateLabelReference (const App::DocumentObject linked, const char subname, App::DocumentObject obj, const std::string &ref, const char newLabel)
	Helper function to update subname reference on label change. More...

static std::vector< std::pair< Property *, std::unique_ptr< Property > > >	updateLabelReferences (App::DocumentObject obj, const char newLabel)
	Helper function to collect changed property when an object re-label. More...

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)

Public Attributes inherited from App::PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase >
friend	atomic_change

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

Protected Attributes inherited from App::AtomicPropertyChangeInterface< PropertyListsT< DocumentObject , std::vector< DocumentObject >, PropertyLinkListBase > >
bool	hasChanged

int	signalCounter
	Counter for invoking transaction start/stop. More...

Constructor & Destructor Documentation

◆ PropertyLinkList()

PropertyLinkList::PropertyLinkList ( )

A constructor.

A more elaborate description of the constructor.

Referenced by Copy(), and CopyOnLinkReplace().

◆ ~PropertyLinkList()

PropertyLinkList::~PropertyLinkList ( )

virtual

A destructor.

A more elaborate description of the destructor.

References Base::Persistence::getClassTypeId(), App::Property::getContainer(), App::Hidden, Base::BaseClass::isDerivedFrom(), and App::DocumentObject::testStatus().

Member Function Documentation

◆ adjustLink()

bool PropertyLinkList::adjustLink ( const std::set< App::DocumentObject * > & inList )

overridevirtual

Called to adjust the link to avoid potential cyclic dependency.

Parameters

inList recursive in-list of the would-be parent

Returns: Return whether the link has been adjusted

This function tries to correct the link to avoid any (sub)object inside in-list. If the adjustment is impossible, exception will be raised

Implements App::PropertyLinkBase.

◆ breakLink()

void PropertyLinkList::breakLink	(	App::DocumentObject *	obj,
		bool	clear
	)

overridevirtual

Called to reset this link property.

Parameters

obj	reset link property if it is linked to this object
clear	if true, then also reset property if the owner of this property is obj

See also: breakLinks()

Implements App::PropertyLinkBase.

References App::Property::getContainer(), and setValues().

◆ Copy()

Property * PropertyLinkList::Copy ( void ) const

overridevirtual

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

Implements App::Property.

References PropertyLinkList().

◆ CopyOnLinkReplace()

Property * PropertyLinkList::CopyOnLinkReplace	(	const App::DocumentObject *	parent,
		App::DocumentObject *	oldObj,
		App::DocumentObject *	newObj
	)		const

overridevirtual

Return a copy of the property if the link replacement affects this property.

Parameters

owner	the parent object whose link property is to be replace. Note that The parent may not be the container of this property. Link sub property can use this opportunity to adjust its relative links.
oldObj	object to be replaced
newObj	object to replace with

Returns: Return a copy of the property that is adjusted for the link replacement operation.

Implements App::PropertyLinkBase.

References App::Property::getContainer(), PropertyLinkList(), and App::PropertyLinkBase::tryReplaceLink().

◆ find() [1/2]

DocumentObject* App::PropertyLinkList::find	(	const char *	sub,
		int *	pindex = `0`
	)		const

References DraftVecUtils::find().

◆ find() [2/2]

DocumentObject * PropertyLinkList::find	(	const std::string &	name,
		int *	pindex = `0`
	)		const

Referenced by App::GroupExtension::extensionGetSubObject(), and App::GeoFeatureGroupExtension::extensionGetSubObject().

◆ getEditorName()

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

overridevirtual

Get the class name of the associated property editor item.

Reimplemented from App::Property.

◆ getLinks()

void PropertyLinkList::getLinks	(	std::vector< App::DocumentObject * > &	objs,
		bool	all = `false`,
		std::vector< std::string > *	subs = `0`,
		bool	newStyle = `true`
	)		const

overridevirtual

Obtain the linked objects.

Parameters

objs	hold the returned linked objects on output
all	if true, then return all the linked object regardless of this LinkScope. If false, then return only if the LinkScope is not hidden.
sub	if given, then return subname references.
newStyle	whether to return new or old style subname reference

Implements App::PropertyLinkBase.

References App::Hidden.

◆ getMemSize()

unsigned int PropertyLinkList::getMemSize ( void ) const

overridevirtual

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.

◆ getPyObject()

PyObject * PropertyLinkList::getPyObject ( void )

overridevirtual

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.

References App::PropertyListsT< DocumentObject *, std::vector< DocumentObject * >, PropertyLinkListBase >::getSize().

◆ getPyValue()

DocumentObject * PropertyLinkList::getPyValue ( PyObject * item ) const

overrideprotectedvirtual

Implements App::PropertyListsT< DocumentObject *, std::vector< DocumentObject * >, PropertyLinkListBase >.

References App::DocumentObjectPy::Type.

◆ Paste()

void PropertyLinkList::Paste ( const Property & from )

overridevirtual

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

Implements App::Property.

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

◆ Restore()

void PropertyLinkList::Restore ( Base::XMLReader & )

overridevirtual

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::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Base::Persistence::getClassTypeId(), App::Property::getContainer(), App::DocumentObject::getDocument(), Base::Type::getName(), Base::XMLReader::getName(), App::Document::getName(), App::Document::getObject(), Base::Persistence::getTypeId(), Base::Type::isDerivedFrom(), Base::XMLReader::isVerbose(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), and setValues().

Referenced by PartDesign::Boolean::handleChangedPropertyName(), Part::BodyBase::onBeforeChange(), and App::PropertyXLinkSubList::upgrade().

◆ Save()

void PropertyLinkList::Save ( Base::Writer & ) const

overridevirtual

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.