Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

TDataStd_ExtStringArray Class Reference

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

#include <TDataStd_ExtStringArray.hxx>

Inheritance diagram for TDataStd_ExtStringArray:
Inheritance graph
[legend]

Public Member Functions

void Init (const Standard_Integer lower, const Standard_Integer upper)
 Initializes the inner array with bounds from <lower> to <upper> More...
 
void SetValue (const Standard_Integer 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. More...
 
void SetID (const Standard_GUID &theGuid) override
 Sets the explicit GUID (user defined) for the attribute. More...
 
void SetID () override
 Sets default GUID for the attribute. More...
 
const TCollection_ExtendedStringValue (const Standard_Integer Index) const
 Returns the value of the <Index>th element of the array. More...
 
const TCollection_ExtendedStringoperator() (const Standard_Integer Index) const
 
Standard_Integer Lower () const
 Return the lower bound. More...
 
Standard_Integer Upper () const
 Return the upper bound. More...
 
Standard_Integer Length () const
 Return the number of elements of <me>. More...
 
void ChangeArray (const Handle< TColStd_HArray1OfExtendedString > &newArray, const Standard_Boolean isCheckItems=Standard_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). More...
 
const Handle< TColStd_HArray1OfExtendedString > & Array () const
 Return the inner array of the ExtStringArray attribute. More...
 
Standard_Boolean GetDelta () const
 
void SetDelta (const Standard_Boolean isDelta)
 for internal use only! More...
 
 TDataStd_ExtStringArray ()
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
void Restore (const Handle< TDF_Attribute > &With) override
 Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
Handle< TDF_AttributeNewEmpty () const override
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
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>. More...
 
virtual Standard_OStreamDump (Standard_OStream &anOS) const override
 Dumps the minimum information about <me> on <aStream>. More...
 
virtual Handle< TDF_DeltaOnModificationDeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const override
 Makes a DeltaOnModification between <me> and <anOldAttribute>. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- 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. More...
 
Standard_Integer Transaction () const
 Returns the transaction index in which the attribute has been created or modified. More...
 
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. More...
 
Standard_Boolean IsValid () const
 Returns true if the attribute is valid; i.e. not a backuped or removed one. More...
 
Standard_Boolean IsNew () const
 Returns true if the attribute has no backup. More...
 
Standard_Boolean IsForgotten () const
 Returns true if the attribute forgotten status is set. More...
 
Standard_Boolean IsAttribute (const Standard_GUID &anID) const
 Returns true if it exists an associated attribute of <me> with <anID> as ID. More...
 
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. More...
 
template<class T >
Standard_Boolean FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const
 Safe variant for arbitrary type of argument. More...
 
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>. More...
 
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. More...
 
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. More...
 
virtual void AfterAddition ()
 Something to do after adding an Attribute to a label. More...
 
virtual void BeforeRemoval ()
 Something to do before removing an Attribute from a label. More...
 
virtual void BeforeForget ()
 Something to do before forgetting an Attribute to a label. More...
 
virtual void AfterResume ()
 Something to do after resuming an Attribute from a label. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void BeforeCommitTransaction ()
 A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method. More...
 
void Backup ()
 Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid". More...
 
Standard_Boolean IsBackuped () const
 Returns true if the attribute backup status is set. This status is set/unset by the Backup() method. More...
 
virtual Handle< TDF_AttributeBackupCopy () const
 Copies the attribute contents into a new other attribute. It is used by Backup(). More...
 
virtual Handle< TDF_DeltaOnAdditionDeltaOnAddition () 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). More...
 
virtual Handle< TDF_DeltaOnForgetDeltaOnForget () const
 Makes an AttributeDelta because <me> has been forgotten. More...
 
virtual Handle< TDF_DeltaOnResumeDeltaOnResume () const
 Makes an AttributeDelta because <me> has been resumed. More...
 
virtual void DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
 Applies a DeltaOnModification to <me>. More...
 
virtual Handle< TDF_DeltaOnRemovalDeltaOnRemoval () const
 Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. More...
 
virtual void References (const Handle< TDF_DataSet > &aDataSet) const
 Adds the first level referenced attributes and labels to <aDataSet>. More...
 
Standard_OStreamoperator<< (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. More...
 
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". More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static const Standard_GUIDGetID ()
 
static Handle< TDataStd_ExtStringArraySet (const TDF_Label &label, const Standard_Integer lower, const Standard_Integer upper, const Standard_Boolean isDelta=Standard_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. More...
 
static Handle< TDataStd_ExtStringArraySet (const TDF_Label &label, const Standard_GUID &theGuid, const Standard_Integer lower, const Standard_Integer upper, const Standard_Boolean isDelta=Standard_False)
 Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>. The ExtStringArray attribute is returned. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Member Functions inherited from TDF_Attribute
 TDF_Attribute ()
 Initializes fields. More...
 

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 Handle< TColStd_HArray1OfExtendedString >& TDataStd_ExtStringArray::Array ( ) const
inline

Return the inner array of the ExtStringArray attribute.

◆ ChangeArray()

void TDataStd_ExtStringArray::ChangeArray ( const Handle< TColStd_HArray1OfExtendedString > &  newArray,
const Standard_Boolean  isCheckItems = Standard_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()

virtual Handle< TDF_DeltaOnModification > TDataStd_ExtStringArray::DeltaOnModification ( const Handle< TDF_Attribute > &  anOldAttribute) const
overridevirtual

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

Reimplemented from TDF_Attribute.

◆ Dump()

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

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

Reimplemented from TDF_Attribute.

◆ DumpJson()

virtual void TDataStd_ExtStringArray::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ GetDelta()

Standard_Boolean 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 Standard_Integer  lower,
const Standard_Integer  upper 
)

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

◆ Length()

Standard_Integer TDataStd_ExtStringArray::Length ( ) const

Return the number of elements of <me>.

◆ Lower()

Standard_Integer TDataStd_ExtStringArray::Lower ( ) const

Return the lower bound.

◆ NewEmpty()

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 Standard_Integer  Index) const
inline

◆ Paste()

void TDataStd_ExtStringArray::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.

◆ Restore()

void TDataStd_ExtStringArray::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.

◆ Set() [1/2]

static Handle< TDataStd_ExtStringArray > TDataStd_ExtStringArray::Set ( const TDF_Label label,
const Standard_GUID theGuid,
const Standard_Integer  lower,
const Standard_Integer  upper,
const Standard_Boolean  isDelta = Standard_False 
)
static

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

◆ Set() [2/2]

static Handle< TDataStd_ExtStringArray > TDataStd_ExtStringArray::Set ( const TDF_Label label,
const Standard_Integer  lower,
const Standard_Integer  upper,
const Standard_Boolean  isDelta = Standard_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.

◆ SetDelta()

void TDataStd_ExtStringArray::SetDelta ( const Standard_Boolean  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 Standard_Integer  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()

Standard_Integer TDataStd_ExtStringArray::Upper ( ) const

Return the upper bound.

◆ Value()

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

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


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