Attribute that contains list of references to features, may be located in different documents. More...

Inheritance diagram for Model_AttributeRefList:

Public Member Functions
virtual void	append (ObjectPtr theObject)
	Appends the feature to the end of a list. More...

virtual void	remove (ObjectPtr theObject)
	Erases the first meet of the feature in the list. More...

virtual int	size (const bool theWithEmpty=true) const
	Returns number of features in the list. More...

virtual void	clear ()
	Removes all references from the list. More...

virtual std::list< ObjectPtr >	list ()
	Returns the list of features. More...

virtual bool	isInList (const ObjectPtr &theObj)
	Returns true if the object is in list. More...

virtual ObjectPtr	object (const int theIndex, const bool theWithEmpty=true)
	Returns the list of features. More...

virtual void	substitute (const ObjectPtr &theCurrent, const ObjectPtr &theNew)
	Substitutes the feature by another one. More...

virtual void	removeLast ()
	Removes the last element in the list. More...

virtual void	remove (const std::set< int > &theIndices)
	Removes the elements from the list. More...

virtual bool	isInitialized ()
	Returns true if attribute was initialized by some value. More...

void	eraseHash ()
	Erases the hashed objects caused by complicated modifications in the list. More...

virtual std::string	attributeType ()
	Returns the type of this class of attributes, not static method. More...

virtual void	setObject (const std::shared_ptr< ModelAPI_Object > &theObject)
	Sets the owner of this attribute. More...

const std::shared_ptr< ModelAPI_Object > &	owner () const
	Returns the owner of this attribute. More...

void	setInitialized ()
	Makes attribute initialized. More...

bool	blockSetInitialized (const bool theBlock)
	Blocks sending "attribute updated" if theBlock is true. More...

void	setIsArgument (const bool theFlag)
	Set this attribute is argument for result (change of this attribute requires update of result). More...

bool	isArgument ()
	Returns true if attribute causes the result change. More...

bool	setImmutable (const bool theFlag)
	Immutable argument can not be changed programmatically (e.g. More...

bool	isImmutable ()
	Returns true if can not be changed programmatically. More...

const std::string &	id () const
	ID of the attribute in Data. More...

virtual void	reset ()
	Resets attribute to default state. More...

Static Public Member Functions
static std::string	typeId ()
	Returns the type of this class of attributes. More...

Protected Member Functions
	Model_AttributeRefList (TDF_Label &theLabel)
	Objects are created for features automatically. More...

virtual void	reinit ()
	Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More...

ObjectPtr	iteratedObject (TDF_ListIteratorOfLabelList &theLIter, TDataStd_ListIteratorOfListOfExtendedString &theExtIter, std::shared_ptr< Model_Document > theDoc) const
	Returns the object by iterators (theExtIter is iterated if necessary) More...

void	createHash ()
	Creates the hash-objects containers (does nothing if hash is already correct) More...

virtual void	setID (const std::string theID)
	Sets the ID of the attribute in Data (called from Data) More...

Protected Attributes
bool	myIsInitialized
	is some value assigned to this attribute More...

bool	mySetInitializedBlocked
	is initialized blocked More...

bool	myIsArgument
	is this attribute used as an argument for execution More...

bool	myIsImmutable
	is this attribute can be changed programmatically (e.g. by constraint) More...

Friends
class	Model_Data

Detailed Description

Attribute that contains list of references to features, may be located in different documents.

Constructor & Destructor Documentation

◆ Model_AttributeRefList()

Model_AttributeRefList::Model_AttributeRefList ( TDF_Label & theLabel )

protected

Objects are created for features automatically.

Member Function Documentation

◆ append()

void Model_AttributeRefList::append ( ObjectPtr theObject )

virtual

Appends the feature to the end of a list.

Implements ModelAPI_AttributeRefList.

◆ remove() [1/2]

void Model_AttributeRefList::remove ( ObjectPtr theObject )

virtual

Erases the first meet of the feature in the list.

Implements ModelAPI_AttributeRefList.

◆ size()

int Model_AttributeRefList::size ( const bool theWithEmpty = true ) const

virtual

Returns number of features in the list.

Parameters

theWithEmpty if it is false, returns the number of not-empty referenced objects

Implements ModelAPI_AttributeRefList.

◆ clear()

void Model_AttributeRefList::clear ( )

virtual

Removes all references from the list.

Implements ModelAPI_AttributeRefList.

◆ list()

std::list< ObjectPtr > Model_AttributeRefList::list ( )

virtual

Returns the list of features.

Implements ModelAPI_AttributeRefList.

◆ isInList()

bool Model_AttributeRefList::isInList ( const ObjectPtr & theObj )

virtual

Returns true if the object is in list.

Implements ModelAPI_AttributeRefList.

◆ object()

ObjectPtr Model_AttributeRefList::object	(	const int	theIndex,
		const bool	theWithEmpty = `true`
	)

virtual

Returns the list of features.

Parameters

theIndex	zero-based index in the list
theWithEmpty	if it is false, counts the not-empty referenced objects only

Implements ModelAPI_AttributeRefList.

◆ substitute()

void Model_AttributeRefList::substitute	(	const ObjectPtr &	theCurrent,
		const ObjectPtr &	theNew
	)

virtual

Substitutes the feature by another one.

Does nothing if such object is not found. Does not support the external documents objects yet.

Implements ModelAPI_AttributeRefList.

◆ removeLast()

void Model_AttributeRefList::removeLast ( )

virtual

Removes the last element in the list.

Does not support the external documents objects yet.

Implements ModelAPI_AttributeRefList.

◆ remove() [2/2]

void Model_AttributeRefList::remove ( const std::set< int > & theIndices )

virtual

Removes the elements from the list.

Does not support the external documents objects yet.

Parameters

theIndices a list of indices of elements to be removed

Implements ModelAPI_AttributeRefList.

◆ isInitialized()

bool Model_AttributeRefList::isInitialized ( )

virtual

Returns true if attribute was initialized by some value.

Reimplemented from ModelAPI_Attribute.

◆ eraseHash()

void Model_AttributeRefList::eraseHash ( )

Erases the hashed objects caused by complicated modifications in the list.

◆ reinit()

void Model_AttributeRefList::reinit ( )

protectedvirtual

Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)

Reimplemented from ModelAPI_Attribute.

◆ iteratedObject()

ObjectPtr Model_AttributeRefList::iteratedObject	(	TDF_ListIteratorOfLabelList &	theLIter,
		TDataStd_ListIteratorOfListOfExtendedString &	theExtIter,
		std::shared_ptr< Model_Document >	theDoc
	)		const

protected

Returns the object by iterators (theExtIter is iterated if necessary)

◆ createHash()

void Model_AttributeRefList::createHash ( )

protected

Creates the hash-objects containers (does nothing if hash is already correct)

◆ typeId()

static std::string ModelAPI_AttributeRefList::typeId ( )

inlinestaticinherited

Returns the type of this class of attributes.

◆ attributeType()

std::string ModelAPI_AttributeRefList::attributeType ( )

virtualinherited

Returns the type of this class of attributes, not static method.

Implements ModelAPI_Attribute.

◆ setObject()

void ModelAPI_Attribute::setObject ( const std::shared_ptr< ModelAPI_Object > & theObject )

virtualinherited

Sets the owner of this attribute.

Reimplemented in Model_AttributeSelection, and Model_AttributeReference.

◆ owner()

const std::shared_ptr< ModelAPI_Object > & ModelAPI_Attribute::owner ( ) const

inherited

Returns the owner of this attribute.

◆ setInitialized()

void ModelAPI_Attribute::setInitialized ( )

inherited

Makes attribute initialized.

◆ blockSetInitialized()

bool ModelAPI_Attribute::blockSetInitialized ( const bool theBlock )

inherited

Blocks sending "attribute updated" if theBlock is true.

Parameters

theBlock a block value

Returns: the previous block value

◆ setIsArgument()

void ModelAPI_Attribute::setIsArgument ( const bool theFlag )

inherited

Set this attribute is argument for result (change of this attribute requires update of result).

By default it is true.

◆ isArgument()

bool ModelAPI_Attribute::isArgument ( )

inherited

Returns true if attribute causes the result change.

◆ setImmutable()

bool ModelAPI_Attribute::setImmutable ( const bool theFlag )

inherited

Immutable argument can not be changed programmatically (e.g.

by constraint) By default it is false. Returns the previous state of the attribute's immutability.

◆ isImmutable()

bool ModelAPI_Attribute::isImmutable ( )

inherited

Returns true if can not be changed programmatically.

◆ id()

const std::string & ModelAPI_Attribute::id ( ) const

inherited

ID of the attribute in Data.

◆ reset()

void ModelAPI_Attribute::reset ( )

virtualinherited

Resets attribute to default state.

Reimplemented in Model_AttributeSelection, Model_AttributeDouble, GeomData_Point2D, and GeomData_Dir.

◆ setID()

void ModelAPI_Attribute::setID ( const std::string theID )

protectedvirtualinherited

Sets the ID of the attribute in Data (called from Data)

Reimplemented in Model_AttributeSelection.

Field Documentation

◆ myIsInitialized

bool ModelAPI_Attribute::myIsInitialized

protectedinherited

is some value assigned to this attribute

◆ mySetInitializedBlocked

bool ModelAPI_Attribute::mySetInitializedBlocked

protectedinherited

is initialized blocked

◆ myIsArgument

bool ModelAPI_Attribute::myIsArgument

protectedinherited

is this attribute used as an argument for execution

◆ myIsImmutable

bool ModelAPI_Attribute::myIsImmutable

protectedinherited

is this attribute can be changed programmatically (e.g. by constraint)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Model_AttributeRefList()

Member Function Documentation

◆ append()

◆ remove() [1/2]

◆ size()

◆ clear()

◆ list()

◆ isInList()

◆ object()

◆ substitute()

◆ removeLast()

◆ remove() [2/2]

◆ isInitialized()

◆ eraseHash()

◆ reinit()

◆ iteratedObject()

◆ createHash()

◆ typeId()

◆ attributeType()

◆ setObject()

◆ owner()

◆ setInitialized()

◆ blockSetInitialized()

◆ setIsArgument()

◆ isArgument()

◆ setImmutable()

◆ isImmutable()

◆ id()

◆ reset()

◆ setID()

Field Documentation

◆ myIsInitialized

◆ mySetInitializedBlocked

◆ myIsArgument

◆ myIsImmutable