The groundwork to define constraint attributes. The constraint attribute contains the following sorts of data: More...

#include <TDataXtd_Constraint.hxx>

Inheritance diagram for TDataXtd_Constraint:

[legend]

Public Member Functions
	TDataXtd_Constraint ()

void	Set (const TDataXtd_ConstraintEnum type, const Handle< TNaming_NamedShape > &G1)
	Finds or creates the constraint attribute defined by the topological attribute G1 and the constraint type type.

void	Set (const TDataXtd_ConstraintEnum type, const Handle< TNaming_NamedShape > &G1, const Handle< TNaming_NamedShape > &G2)
	Finds or creates the constraint attribute defined by the topological attributes G1 and G2, and by the constraint type type.

void	Set (const TDataXtd_ConstraintEnum type, const Handle< TNaming_NamedShape > &G1, const Handle< TNaming_NamedShape > &G2, const Handle< TNaming_NamedShape > &G3)
	Finds or creates the constraint attribute defined by the topological attributes G1, G2 and G3, and by the constraint type type.

void	Set (const TDataXtd_ConstraintEnum type, const Handle< TNaming_NamedShape > &G1, const Handle< TNaming_NamedShape > &G2, const Handle< TNaming_NamedShape > &G3, const Handle< TNaming_NamedShape > &G4)
	Finds or creates the constraint attribute defined by the topological attributes G1, G2, G3 and G4, and by the constraint type type.

Standard_Boolean	Verified () const
	Returns true if this constraint attribute is valid. By default, true is returned. When the value of a dimension is changed or when a geometry is moved, false is returned until the solver sets it back to true.

TDataXtd_ConstraintEnum	GetType () const
	Returns the type of constraint. This will be an element of the TDataXtd_ConstraintEnum enumeration.

Standard_Boolean	IsPlanar () const
	Returns true if this constraint attribute is two-dimensional.

const Handle< TNaming_NamedShape > &	GetPlane () const
	Returns the topological attribute of the plane used for planar - i.e., 2D - constraints. This plane is attached to another label. If the constraint is not planar, in other words, 3D, this function will return a null handle.

Standard_Boolean	IsDimension () const
	Returns true if this constraint attribute is a dimension, and therefore has a value.

const Handle< TDataStd_Real > &	GetValue () const
	Returns the value of a dimension. This value is a reference to a TDataStd_Real attribute. If the attribute is not a dimension, this value will be 0. Use IsDimension to test this condition.

Standard_Integer	NbGeometries () const
	Returns the number of geometry attributes in this constraint attribute. This number will be between 1 and 4.

Handle< TNaming_NamedShape >	GetGeometry (const Standard_Integer Index) const
	Returns the integer index Index used to access the array of the constraint or stored geometries of a dimension Index has a value between 1 and 4.

void	ClearGeometries ()
	Removes the geometries involved in the constraint or dimension from the array of topological attributes where they are stored.

void	SetType (const TDataXtd_ConstraintEnum CTR)
	Finds or creates the type of constraint CTR.

void	SetPlane (const Handle< TNaming_NamedShape > &plane)
	Finds or creates the plane of the 2D constraint attribute, defined by the planar topological attribute plane.

void	SetValue (const Handle< TDataStd_Real > &V)
	Finds or creates the real number value V of the dimension constraint attribute.

void	SetGeometry (const Standard_Integer Index, const Handle< TNaming_NamedShape > &G)
	Finds or creates the underlying geometry of the constraint defined by the topological attribute G and the integer index Index.

void	Verified (const Standard_Boolean status)
	Returns true if this constraint attribute defined by status is valid. By default, true is returned. When the value of a dimension is changed or when a geometry is moved, false is returned until the solver sets it back to true. If status is false, Verified is set to false.

void	Inverted (const Standard_Boolean status)

Standard_Boolean	Inverted () const

void	Reversed (const Standard_Boolean status)

Standard_Boolean	Reversed () const

const Standard_GUID &	ID () const override
	Returns the ID of the attribute.

void	Restore (const Handle< TDF_Attribute > &With) override
	Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

Handle< TDF_Attribute >	NewEmpty () const override
	Returns an new empty attribute from the good end type. It is used by the copy algorithm.

void	Paste (const Handle< TDF_Attribute > &Into, const Handle< TDF_RelocationTable > &RT) const override
	This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.

virtual Standard_OStream &	Dump (Standard_OStream &anOS) const override
	Dumps the minimum information about <me> on <aStream>.

virtual void	References (const Handle< TDF_DataSet > &DS) const override
	Adds the first level referenced attributes and labels to <aDataSet>.

Public Member Functions inherited from TDF_Attribute
virtual void	SetID (const Standard_GUID &)
	Sets specific ID of the attribute (supports several attributes of one type at the same label feature).

virtual void	SetID ()
	Sets default ID defined in nested class (to be used for attributes having User ID feature).

const TDF_Label	Label () const
	Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.

Standard_Integer	Transaction () const
	Returns the transaction index in which the attribute has been created or modified.

Standard_Integer	UntilTransaction () const
	Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.

Standard_Boolean	IsValid () const
	Returns true if the attribute is valid; i.e. not a backuped or removed one.

Standard_Boolean	IsNew () const
	Returns true if the attribute has no backup.

Standard_Boolean	IsForgotten () const
	Returns true if the attribute forgotten status is set.

Standard_Boolean	IsAttribute (const Standard_GUID &anID) const
	Returns true if it exists an associated attribute of <me> with <anID> as ID.

Standard_Boolean	FindAttribute (const Standard_GUID &anID, Handle< TDF_Attribute > &anAttribute) const
	Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.

template<class T >
Standard_Boolean	FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const
	Safe variant for arbitrary type of argument.

void	AddAttribute (const Handle< TDF_Attribute > &other) const
	Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.

Standard_Boolean	ForgetAttribute (const Standard_GUID &aguid) const
	Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.

void	ForgetAllAttributes (const Standard_Boolean clearChildren=Standard_True) const
	Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call.

virtual void	AfterAddition ()
	Something to do after adding an Attribute to a label.

virtual void	BeforeRemoval ()
	Something to do before removing an Attribute from a label.

virtual void	BeforeForget ()
	Something to do before forgetting an Attribute to a label.

virtual void	AfterResume ()
	Something to do after resuming an Attribute from a label.

virtual Standard_Boolean	AfterRetrieval (const Standard_Boolean forceIt=Standard_False)
	Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.

virtual Standard_Boolean	BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.

virtual Standard_Boolean	AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.

virtual void	BeforeCommitTransaction ()
	A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.

void	Backup ()
	Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".

Standard_Boolean	IsBackuped () const
	Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.

virtual Handle< TDF_Attribute >	BackupCopy () const
	Copies the attribute contents into a new other attribute. It is used by Backup().

virtual Handle< TDF_DeltaOnAddition >	DeltaOnAddition () const
	Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).

virtual Handle< TDF_DeltaOnForget >	DeltaOnForget () const
	Makes an AttributeDelta because <me> has been forgotten.

virtual Handle< TDF_DeltaOnResume >	DeltaOnResume () const
	Makes an AttributeDelta because <me> has been resumed.

virtual Handle< TDF_DeltaOnModification >	DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const
	Makes a DeltaOnModification between <me> and.

virtual void	DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
	Applies a DeltaOnModification to <me>.

virtual Handle< TDF_DeltaOnRemoval >	DeltaOnRemoval () const
	Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.

Standard_OStream &	operator<< (Standard_OStream &anOS) const

virtual void	ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const
	Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.

void	Forget (const Standard_Integer aTransaction)
	Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static const Standard_GUID &	GetID ()
	Returns the GUID for constraints.

static Handle< TDataXtd_Constraint >	Set (const TDF_Label &label)
	Finds or creates the 2D constraint attribute defined by the planar topological attribute plane and the label label.

static void	CollectChildConstraints (const TDF_Label &aLabel, TDF_LabelList &TheList)
	collects constraints on Childs for label <aLabel>

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Member Functions inherited from TDF_Attribute
	TDF_Attribute ()
	Initializes fields.

Detailed Description

The groundwork to define constraint attributes. The constraint attribute contains the following sorts of data:

Type whether the constraint attribute is a geometric constraint or a dimension
Value the real number value of a numeric constraint such as an angle or a radius
Geometries to identify the geometries underlying the topological attributes which define the constraint (up to 4)
Plane for 2D constraints.

Constructor & Destructor Documentation

◆ TDataXtd_Constraint()

TDataXtd_Constraint::TDataXtd_Constraint ( )

Member Function Documentation

◆ ClearGeometries()

void TDataXtd_Constraint::ClearGeometries ( )

Removes the geometries involved in the constraint or dimension from the array of topological attributes where they are stored.

◆ CollectChildConstraints()

static void TDataXtd_Constraint::CollectChildConstraints	(	const TDF_Label &	aLabel,
		TDF_LabelList &	TheList
	)

static

collects constraints on Childs for label <aLabel>

◆ Dump()

virtual Standard_OStream & TDataXtd_Constraint::Dump ( Standard_OStream & anOS ) const

overridevirtual

Dumps the minimum information about <me> on <aStream>.

Reimplemented from TDF_Attribute.

◆ GetGeometry()

Handle< TNaming_NamedShape > TDataXtd_Constraint::GetGeometry ( const Standard_Integer Index ) const

Returns the integer index Index used to access the array of the constraint or stored geometries of a dimension Index has a value between 1 and 4.

methods to write constraint fields (use builder)

◆ GetID()

static const Standard_GUID & TDataXtd_Constraint::GetID ( )

static

Returns the GUID for constraints.

◆ GetPlane()

const Handle< TNaming_NamedShape > & TDataXtd_Constraint::GetPlane ( ) const

Returns the topological attribute of the plane used for planar - i.e., 2D - constraints. This plane is attached to another label. If the constraint is not planar, in other words, 3D, this function will return a null handle.

◆ GetType()

TDataXtd_ConstraintEnum TDataXtd_Constraint::GetType ( ) const

Returns the type of constraint. This will be an element of the TDataXtd_ConstraintEnum enumeration.

◆ GetValue()

const Handle< TDataStd_Real > & TDataXtd_Constraint::GetValue ( ) const

Returns the value of a dimension. This value is a reference to a TDataStd_Real attribute. If the attribute is not a dimension, this value will be 0. Use IsDimension to test this condition.

◆ ID()

const Standard_GUID & TDataXtd_Constraint::ID ( ) const

overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ Inverted() [1/2]

Standard_Boolean TDataXtd_Constraint::Inverted ( ) const

◆ Inverted() [2/2]

void TDataXtd_Constraint::Inverted ( const Standard_Boolean status )

◆ IsDimension()

Standard_Boolean TDataXtd_Constraint::IsDimension ( ) const

Returns true if this constraint attribute is a dimension, and therefore has a value.

◆ IsPlanar()

Standard_Boolean TDataXtd_Constraint::IsPlanar ( ) const

Returns true if this constraint attribute is two-dimensional.

◆ NbGeometries()

Standard_Integer TDataXtd_Constraint::NbGeometries ( ) const

Returns the number of geometry attributes in this constraint attribute. This number will be between 1 and 4.

◆ NewEmpty()

Handle< TDF_Attribute > TDataXtd_Constraint::NewEmpty ( ) const

overridevirtual

Returns an new empty attribute from the good end type. It is used by the copy algorithm.

Implements TDF_Attribute.

◆ Paste()

void TDataXtd_Constraint::Paste	(	const Handle< TDF_Attribute > &	intoAttribute,
		const Handle< TDF_RelocationTable > &	aRelocationTable
	)		const

overridevirtual

This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.

The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!

It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

Implements TDF_Attribute.

◆ References()

virtual void TDataXtd_Constraint::References ( const Handle< TDF_DataSet > & aDataSet ) const

overridevirtual

Adds the first level referenced attributes and labels to <aDataSet>.

For this, use the AddLabel or AddAttribute of DataSet.

If there is none, do not implement the method.

Reimplemented from TDF_Attribute.

◆ Restore()

void TDataXtd_Constraint::Restore ( const Handle< TDF_Attribute > & anAttribute )

overridevirtual

Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

Implements TDF_Attribute.

◆ Reversed() [1/2]

Standard_Boolean TDataXtd_Constraint::Reversed ( ) const

◆ Reversed() [2/2]

void TDataXtd_Constraint::Reversed ( const Standard_Boolean status )

◆ Set() [1/5]

void TDataXtd_Constraint::Set	(	const TDataXtd_ConstraintEnum	type,
		const Handle< TNaming_NamedShape > &	G1
	)

Finds or creates the constraint attribute defined by the topological attribute G1 and the constraint type type.

◆ Set() [2/5]

void TDataXtd_Constraint::Set	(	const TDataXtd_ConstraintEnum	type,
		const Handle< TNaming_NamedShape > &	G1,
		const Handle< TNaming_NamedShape > &	G2
	)

Finds or creates the constraint attribute defined by the topological attributes G1 and G2, and by the constraint type type.

◆ Set() [3/5]

void TDataXtd_Constraint::Set	(	const TDataXtd_ConstraintEnum	type,
		const Handle< TNaming_NamedShape > &	G1,
		const Handle< TNaming_NamedShape > &	G2,
		const Handle< TNaming_NamedShape > &	G3
	)

Finds or creates the constraint attribute defined by the topological attributes G1, G2 and G3, and by the constraint type type.

◆ Set() [4/5]

void TDataXtd_Constraint::Set	(	const TDataXtd_ConstraintEnum	type,
		const Handle< TNaming_NamedShape > &	G1,
		const Handle< TNaming_NamedShape > &	G2,
		const Handle< TNaming_NamedShape > &	G3,
		const Handle< TNaming_NamedShape > &	G4
	)

Finds or creates the constraint attribute defined by the topological attributes G1, G2, G3 and G4, and by the constraint type type.

methods to read constraint fields

◆ Set() [5/5]

static Handle< TDataXtd_Constraint > TDataXtd_Constraint::Set ( const TDF_Label & label )

static

Finds or creates the 2D constraint attribute defined by the planar topological attribute plane and the label label.

Constraint methods

◆ SetGeometry()

void TDataXtd_Constraint::SetGeometry	(	const Standard_Integer	Index,
		const Handle< TNaming_NamedShape > &	G
	)

Finds or creates the underlying geometry of the constraint defined by the topological attribute G and the integer index Index.

◆ SetPlane()

void TDataXtd_Constraint::SetPlane ( const Handle< TNaming_NamedShape > & plane )

Finds or creates the plane of the 2D constraint attribute, defined by the planar topological attribute plane.

◆ SetType()

void TDataXtd_Constraint::SetType ( const TDataXtd_ConstraintEnum CTR )

Finds or creates the type of constraint CTR.

◆ SetValue()

void TDataXtd_Constraint::SetValue ( const Handle< TDataStd_Real > & V )

Finds or creates the real number value V of the dimension constraint attribute.

◆ Verified() [1/2]

Standard_Boolean TDataXtd_Constraint::Verified ( ) const

Returns true if this constraint attribute is valid. By default, true is returned. When the value of a dimension is changed or when a geometry is moved, false is returned until the solver sets it back to true.

◆ Verified() [2/2]

void TDataXtd_Constraint::Verified ( const Standard_Boolean status )

Returns true if this constraint attribute defined by status is valid. By default, true is returned. When the value of a dimension is changed or when a geometry is moved, false is returned until the solver sets it back to true. If status is false, Verified is set to false.

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

TDataXtd_Constraint.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TDataXtd_Constraint()

Member Function Documentation

◆ ClearGeometries()

◆ CollectChildConstraints()

◆ Dump()

◆ GetGeometry()

methods to write constraint fields (use builder)

◆ GetID()

◆ GetPlane()

◆ GetType()

◆ GetValue()

◆ ID()

◆ Inverted() [1/2]

◆ Inverted() [2/2]

◆ IsDimension()

◆ IsPlanar()

◆ NbGeometries()

◆ NewEmpty()

◆ Paste()

◆ References()

◆ Restore()

◆ Reversed() [1/2]

◆ Reversed() [2/2]

◆ Set() [1/5]

◆ Set() [2/5]

◆ Set() [3/5]

◆ Set() [4/5]

methods to read constraint fields

◆ Set() [5/5]

Constraint methods

◆ SetGeometry()

◆ SetPlane()

◆ SetType()

◆ SetValue()

◆ Verified() [1/2]

◆ Verified() [2/2]