ExtStringArray Attribute. Handles an array of UNICODE strings (represented by the TCollection_ExtendedString class). More...

#include <TDataStd_ExtStringArray.hxx>

Inheritance diagram for TDataStd_ExtStringArray:

[legend]

Public Member Functions
void	Init (const int lower, const int upper)
	Initializes the inner array with bounds from <lower> to <upper>

void	SetValue (const int Index, const TCollection_ExtendedString &Value)
	Sets the <Index>th element of the array to OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array.

void	SetID (const Standard_GUID &theGuid) override
	Sets the explicit GUID (user defined) for the attribute.

void	SetID () override
	Sets default GUID for the attribute.

const TCollection_ExtendedString &	Value (const int Index) const
	Returns the value of the <Index>th element of the array.

const TCollection_ExtendedString &	operator() (const int Index) const

int	Lower () const
	Return the lower bound.

int	Upper () const
	Return the upper bound.

int	Length () const
	Return the number of elements of <me>.

void	ChangeArray (const occ::handle< NCollection_HArray1< TCollection_ExtendedString > > &newArray, const bool isCheckItems=true)
	Sets the inner array <myValue> of the ExtStringArray attribute to <newArray>. If value of <newArray> differs from <myValue>, Backup performed and myValue refers to new instance of HArray1OfExtendedString that holds <newArray> values If <isCheckItems> equal True each item of <newArray> will be checked with each item of <myValue> for coincidence (to avoid backup).

const occ::handle< NCollection_HArray1< TCollection_ExtendedString > > &	Array () const
	Return the inner array of the ExtStringArray attribute.

bool	GetDelta () const

void	SetDelta (const bool isDelta)
	for internal use only!

	TDataStd_ExtStringArray ()

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

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

occ::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 occ::handle< TDF_Attribute > &Into, const occ::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>.

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

occ::handle< TDF_DeltaOnModification >	DeltaOnModification (const occ::handle< TDF_Attribute > &anOldAttribute) const override
	Makes a DeltaOnModification between <me> and <anOldAttribute>.

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

Public Member Functions inherited from TDF_Attribute
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.

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

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

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

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

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

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

bool	FindAttribute (const Standard_GUID &anID, occ::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 >
bool	FindAttribute (const Standard_GUID &theID, occ::handle< T > &theAttr) const
	Safe variant for arbitrary type of argument.

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

bool	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 bool clearChildren=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 bool	AfterRetrieval (const bool forceIt=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 bool	BeforeUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=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 bool	AfterUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=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".

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

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

virtual occ::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 occ::handle< TDF_DeltaOnForget >	DeltaOnForget () const
	Makes an AttributeDelta because <me> has been forgotten.

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

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

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

virtual void	References (const occ::handle< TDF_DataSet > &aDataSet) const
	Adds the first level referenced attributes and labels to <aDataSet>.

Standard_OStream &	operator<< (Standard_OStream &anOS) const

virtual void	ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, NCollection_IndexedMap< occ::handle< TDF_Attribute > > &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 int aTransaction)
	Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".

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 ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

bool	IsKind (const char *const 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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

Static Public Member Functions
static const Standard_GUID &	GetID ()

static occ::handle< TDataStd_ExtStringArray >	Set (const TDF_Label &label, const int lower, const int upper, const bool isDelta=false)
	Finds, or creates, an ExtStringArray attribute with <lower> and <upper> bounds on the specified label. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, all input parameters are refused and the found attribute is returned.

static occ::handle< TDataStd_ExtStringArray >	Set (const TDF_Label &label, const Standard_GUID &theGuid, const int lower, const int upper, const bool isDelta=false)
	Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>. The ExtStringArray attribute is returned.

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

ExtStringArray Attribute. Handles an array of UNICODE strings (represented by the TCollection_ExtendedString class).

Constructor & Destructor Documentation

◆ TDataStd_ExtStringArray()

TDataStd_ExtStringArray::TDataStd_ExtStringArray ( )

Member Function Documentation

◆ Array()

const occ::handle< NCollection_HArray1< TCollection_ExtendedString > > & TDataStd_ExtStringArray::Array ( ) const

inline

Return the inner array of the ExtStringArray attribute.

◆ ChangeArray()

void TDataStd_ExtStringArray::ChangeArray	(	const occ::handle< NCollection_HArray1< TCollection_ExtendedString > > &	newArray,
		const bool	isCheckItems = true )

Sets the inner array <myValue> of the ExtStringArray attribute to <newArray>. If value of <newArray> differs from <myValue>, Backup performed and myValue refers to new instance of HArray1OfExtendedString that holds <newArray> values If <isCheckItems> equal True each item of <newArray> will be checked with each item of <myValue> for coincidence (to avoid backup).

◆ DeltaOnModification()

occ::handle< TDF_DeltaOnModification > TDataStd_ExtStringArray::DeltaOnModification ( const occ::handle< TDF_Attribute > & anOldAttribute ) const

overridevirtual

Makes a DeltaOnModification between <me> and <anOldAttribute>.

Reimplemented from TDF_Attribute.

◆ Dump()

Standard_OStream & TDataStd_ExtStringArray::Dump ( Standard_OStream & anOS ) const

overridevirtual

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

Reimplemented from TDF_Attribute.

◆ DumpJson()

void TDataStd_ExtStringArray::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ GetDelta()

bool TDataStd_ExtStringArray::GetDelta ( ) const

inline

◆ GetID()

static const Standard_GUID & TDataStd_ExtStringArray::GetID ( )

static

class methods

Returns the GUID for the attribute.

◆ ID()

const Standard_GUID & TDataStd_ExtStringArray::ID ( ) const

overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ Init()

void TDataStd_ExtStringArray::Init	(	const int	lower,
		const int	upper )

Initializes the inner array with bounds from <lower> to <upper>

◆ Length()

int TDataStd_ExtStringArray::Length ( ) const

Return the number of elements of <me>.

◆ Lower()

int TDataStd_ExtStringArray::Lower ( ) const

Return the lower bound.

◆ NewEmpty()

occ::handle< TDF_Attribute > TDataStd_ExtStringArray::NewEmpty ( ) const

overridevirtual

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

Implements TDF_Attribute.

◆ operator()()

const TCollection_ExtendedString & TDataStd_ExtStringArray::operator() ( const int Index ) const

inline

◆ Paste()

void TDataStd_ExtStringArray::Paste	(	const occ::handle< TDF_Attribute > &	intoAttribute,
		const occ::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.

◆ Restore()

void TDataStd_ExtStringArray::Restore ( const occ::handle< TDF_Attribute > & anAttribute )

overridevirtual

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

Implements TDF_Attribute.

◆ Set() [1/2]

static occ::handle< TDataStd_ExtStringArray > TDataStd_ExtStringArray::Set	(	const TDF_Label &	label,
		const int	lower,
		const int	upper,
		const bool	isDelta = false )

static

Finds, or creates, an ExtStringArray attribute with <lower> and <upper> bounds on the specified label. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, all input parameters are refused and the found attribute is returned.

◆ Set() [2/2]

static occ::handle< TDataStd_ExtStringArray > TDataStd_ExtStringArray::Set	(	const TDF_Label &	label,
		const Standard_GUID &	theGuid,
		const int	lower,
		const int	upper,
		const bool	isDelta = false )

static

Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>. The ExtStringArray attribute is returned.

◆ SetDelta()

void TDataStd_ExtStringArray::SetDelta ( const bool isDelta )

inline

for internal use only!

◆ SetID() [1/2]

void TDataStd_ExtStringArray::SetID ( )

overridevirtual

Sets default GUID for the attribute.

Reimplemented from TDF_Attribute.

◆ SetID() [2/2]

void TDataStd_ExtStringArray::SetID ( const Standard_GUID & theGuid )

overridevirtual

Sets the explicit GUID (user defined) for the attribute.

Reimplemented from TDF_Attribute.

◆ SetValue()

void TDataStd_ExtStringArray::SetValue	(	const int	Index,
		const TCollection_ExtendedString &	Value )

Sets the <Index>th element of the array to OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array.

◆ Upper()

int TDataStd_ExtStringArray::Upper ( ) const

Return the upper bound.

◆ Value()

const TCollection_ExtendedString & TDataStd_ExtStringArray::Value ( const int Index ) const

Returns the value of the <Index>th element of the array.

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

TDataStd_ExtStringArray.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TDataStd_ExtStringArray()

Member Function Documentation

◆ Array()

◆ ChangeArray()

◆ DeltaOnModification()

◆ Dump()

◆ DumpJson()

◆ GetDelta()

◆ GetID()

class methods

◆ ID()

◆ Init()

◆ Length()

◆ Lower()

◆ NewEmpty()

◆ operator()()

◆ Paste()

◆ Restore()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetDelta()

◆ SetID() [1/2]

◆ SetID() [2/2]

◆ SetValue()

◆ Upper()

◆ Value()