Contains a named data. More...
#include <TDataStd_NamedData.hxx>
Inheritance diagram for TDataStd_NamedData:
Public Member Functions | |
| TDataStd_NamedData () | |
| Standard_Boolean | HasIntegers () const |
| Returns true if at least one named integer value is kept in the attribute. More... | |
| Standard_Boolean | HasInteger (const TCollection_ExtendedString &theName) const |
| Returns true if the attribute contains specified by Name integer value. More... | |
| Standard_Integer | GetInteger (const TCollection_ExtendedString &theName) |
| Returns the integer value specified by the Name. It returns 0 if internal map doesn't contain the specified integer (use HasInteger() to check before). More... | |
| void | SetInteger (const TCollection_ExtendedString &theName, const Standard_Integer theInteger) |
| Defines a named integer. If the integer already exists, it changes its value to <theInteger>. More... | |
| const TColStd_DataMapOfStringInteger & | GetIntegersContainer () |
| Returns the internal container of named integers. More... | |
| void | ChangeIntegers (const TColStd_DataMapOfStringInteger &theIntegers) |
| Replace the container content by new content of the <theIntegers>. More... | |
| Standard_Boolean | HasReals () const |
| Returns true if at least one named real value is kept in the attribute. More... | |
| Standard_Boolean | HasReal (const TCollection_ExtendedString &theName) const |
| Returns true if the attribute contains a real specified by Name. More... | |
| Standard_Real | GetReal (const TCollection_ExtendedString &theName) |
| Returns the named real. It returns 0.0 if there is no such a named real (use HasReal()). More... | |
| void | SetReal (const TCollection_ExtendedString &theName, const Standard_Real theReal) |
| Defines a named real. If the real already exists, it changes its value to <theReal>. More... | |
| const TDataStd_DataMapOfStringReal & | GetRealsContainer () |
| Returns the internal container of named reals. More... | |
| void | ChangeReals (const TDataStd_DataMapOfStringReal &theReals) |
| Replace the container content by new content of the <theReals>. More... | |
| Standard_Boolean | HasStrings () const |
| Returns true if there are some named strings in the attribute. More... | |
| Standard_Boolean | HasString (const TCollection_ExtendedString &theName) const |
| Returns true if the attribute contains this named string. More... | |
| const TCollection_ExtendedString & | GetString (const TCollection_ExtendedString &theName) |
| Returns the named string. It returns an empty string if there is no such a named string (use HasString()). More... | |
| void | SetString (const TCollection_ExtendedString &theName, const TCollection_ExtendedString &theString) |
| Defines a named string. If the string already exists, it changes its value to <theString>. More... | |
| const TDataStd_DataMapOfStringString & | GetStringsContainer () |
| Returns the internal container of named strings. More... | |
| void | ChangeStrings (const TDataStd_DataMapOfStringString &theStrings) |
| Replace the container content by new content of the <theStrings>. More... | |
| Standard_Boolean | HasBytes () const |
| Returns true if there are some named bytes in the attribute. More... | |
| Standard_Boolean | HasByte (const TCollection_ExtendedString &theName) const |
| Returns true if the attribute contains this named byte. More... | |
| Standard_Byte | GetByte (const TCollection_ExtendedString &theName) |
| Returns the named byte. It returns 0 if there is no such a named byte (use HasByte()). More... | |
| void | SetByte (const TCollection_ExtendedString &theName, const Standard_Byte theByte) |
| Defines a named byte. If the byte already exists, it changes its value to <theByte>. More... | |
| const TDataStd_DataMapOfStringByte & | GetBytesContainer () |
| Returns the internal container of named bytes. More... | |
| void | ChangeBytes (const TDataStd_DataMapOfStringByte &theBytes) |
| Replace the container content by new content of the <theBytes>. More... | |
| Standard_Boolean | HasArraysOfIntegers () const |
| Returns true if there are some named arrays of integer values in the attribute. More... | |
| Standard_Boolean | HasArrayOfIntegers (const TCollection_ExtendedString &theName) const |
| Returns true if the attribute contains this named array of integer values. More... | |
| const Handle< TColStd_HArray1OfInteger > & | GetArrayOfIntegers (const TCollection_ExtendedString &theName) |
| Returns the named array of integer values. It returns a NULL Handle if there is no such a named array of integers (use HasArrayOfIntegers()). More... | |
| void | SetArrayOfIntegers (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfInteger > &theArrayOfIntegers) |
| Defines a named array of integer values. If the array already exists, it changes its value to <theArrayOfIntegers>. More... | |
| const TDataStd_DataMapOfStringHArray1OfInteger & | GetArraysOfIntegersContainer () |
| Returns the internal container of named arrays of integer values. More... | |
| void | ChangeArraysOfIntegers (const TDataStd_DataMapOfStringHArray1OfInteger &theArraysOfIntegers) |
| Replace the container content by new content of the <theArraysOfIntegers>. More... | |
| Standard_Boolean | HasArraysOfReals () const |
| Returns true if there are some named arrays of real values in the attribute. More... | |
| Standard_Boolean | HasArrayOfReals (const TCollection_ExtendedString &theName) const |
| Returns true if the attribute contains this named array of real values. More... | |
| const Handle< TColStd_HArray1OfReal > & | GetArrayOfReals (const TCollection_ExtendedString &theName) |
| Returns the named array of real values. It returns a NULL Handle if there is no such a named array of reals (use HasArrayOfReals()). More... | |
| void | SetArrayOfReals (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfReal > &theArrayOfReals) |
| Defines a named array of real values. If the array already exists, it changes its value to <theArrayOfReals>. More... | |
| const TDataStd_DataMapOfStringHArray1OfReal & | GetArraysOfRealsContainer () |
| Returns the internal container of named arrays of real values. More... | |
| void | ChangeArraysOfReals (const TDataStd_DataMapOfStringHArray1OfReal &theArraysOfReals) |
| Replace the container content by new content of the <theArraysOfReals>. More... | |
| const Standard_GUID & | ID () 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_Attribute > | NewEmpty () 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_OStream & | Dump (Standard_OStream &anOS) const override |
| Dumps the minimum information about <me> on <aStream>. 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 carefull 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 mecanisms. Be carefull 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_Attribute > | BackupCopy () const |
| Copies the attribute contents into a new other attribute. It is used by Backup(). More... | |
| 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). More... | |
| virtual Handle< TDF_DeltaOnForget > | DeltaOnForget () const |
| Makes an AttributeDelta because <me> has been forgotten. More... | |
| virtual Handle< TDF_DeltaOnResume > | DeltaOnResume () const |
| Makes an AttributeDelta because <me> has been resumed. More... | |
| virtual Handle< TDF_DeltaOnModification > | DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const |
| Makes a DeltaOnModification between <me> and <anOldAttribute. More... | |
| virtual void | DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta) |
| Applies a DeltaOnModification to <me>. More... | |
| virtual Handle< TDF_DeltaOnRemoval > | DeltaOnRemoval () 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_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. 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 MMgt_TShared | |
| virtual void | Delete () const override |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. 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_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. 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_GUID & | GetID () |
| <>Static methods
Returns the ID of the named data attribute. More... | |
| static Handle< TDataStd_NamedData > | Set (const TDF_Label &label) |
| Finds or creates a named data attribute. 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
Contains a named data.
Constructor & Destructor Documentation
| TDataStd_NamedData::TDataStd_NamedData | ( | ) |
Member Function Documentation
| void TDataStd_NamedData::ChangeArraysOfIntegers | ( | const TDataStd_DataMapOfStringHArray1OfInteger & | theArraysOfIntegers | ) |
Replace the container content by new content of the <theArraysOfIntegers>.
| void TDataStd_NamedData::ChangeArraysOfReals | ( | const TDataStd_DataMapOfStringHArray1OfReal & | theArraysOfReals | ) |
Replace the container content by new content of the <theArraysOfReals>.
| void TDataStd_NamedData::ChangeBytes | ( | const TDataStd_DataMapOfStringByte & | theBytes | ) |
Replace the container content by new content of the <theBytes>.
| void TDataStd_NamedData::ChangeIntegers | ( | const TColStd_DataMapOfStringInteger & | theIntegers | ) |
Replace the container content by new content of the <theIntegers>.
| void TDataStd_NamedData::ChangeReals | ( | const TDataStd_DataMapOfStringReal & | theReals | ) |
Replace the container content by new content of the <theReals>.
| void TDataStd_NamedData::ChangeStrings | ( | const TDataStd_DataMapOfStringString & | theStrings | ) |
Replace the container content by new content of the <theStrings>.
|
overridevirtual |
Dumps the minimum information about <me> on <aStream>.
Reimplemented from TDF_Attribute.
| const Handle< TColStd_HArray1OfInteger >& TDataStd_NamedData::GetArrayOfIntegers | ( | const TCollection_ExtendedString & | theName | ) |
Returns the named array of integer values. It returns a NULL Handle if there is no such a named array of integers (use HasArrayOfIntegers()).
| const Handle< TColStd_HArray1OfReal >& TDataStd_NamedData::GetArrayOfReals | ( | const TCollection_ExtendedString & | theName | ) |
Returns the named array of real values. It returns a NULL Handle if there is no such a named array of reals (use HasArrayOfReals()).
| const TDataStd_DataMapOfStringHArray1OfInteger& TDataStd_NamedData::GetArraysOfIntegersContainer | ( | ) |
Returns the internal container of named arrays of integer values.
| const TDataStd_DataMapOfStringHArray1OfReal& TDataStd_NamedData::GetArraysOfRealsContainer | ( | ) |
Returns the internal container of named arrays of real values.
| Standard_Byte TDataStd_NamedData::GetByte | ( | const TCollection_ExtendedString & | theName | ) |
Returns the named byte. It returns 0 if there is no such a named byte (use HasByte()).
| const TDataStd_DataMapOfStringByte& TDataStd_NamedData::GetBytesContainer | ( | ) |
Returns the internal container of named bytes.
|
static |
<>Static methods Returns the ID of the named data attribute.
| Standard_Integer TDataStd_NamedData::GetInteger | ( | const TCollection_ExtendedString & | theName | ) |
Returns the integer value specified by the Name. It returns 0 if internal map doesn't contain the specified integer (use HasInteger() to check before).
| const TColStd_DataMapOfStringInteger& TDataStd_NamedData::GetIntegersContainer | ( | ) |
Returns the internal container of named integers.
| Standard_Real TDataStd_NamedData::GetReal | ( | const TCollection_ExtendedString & | theName | ) |
Returns the named real. It returns 0.0 if there is no such a named real (use HasReal()).
| const TDataStd_DataMapOfStringReal& TDataStd_NamedData::GetRealsContainer | ( | ) |
Returns the internal container of named reals.
| const TCollection_ExtendedString& TDataStd_NamedData::GetString | ( | const TCollection_ExtendedString & | theName | ) |
Returns the named string. It returns an empty string if there is no such a named string (use HasString()).
| const TDataStd_DataMapOfStringString& TDataStd_NamedData::GetStringsContainer | ( | ) |
Returns the internal container of named strings.
| Standard_Boolean TDataStd_NamedData::HasArrayOfIntegers | ( | const TCollection_ExtendedString & | theName | ) | const |
Returns true if the attribute contains this named array of integer values.
| Standard_Boolean TDataStd_NamedData::HasArrayOfReals | ( | const TCollection_ExtendedString & | theName | ) | const |
Returns true if the attribute contains this named array of real values.
| Standard_Boolean TDataStd_NamedData::HasArraysOfIntegers | ( | ) | const |
Returns true if there are some named arrays of integer values in the attribute.
| Standard_Boolean TDataStd_NamedData::HasArraysOfReals | ( | ) | const |
Returns true if there are some named arrays of real values in the attribute.
| Standard_Boolean TDataStd_NamedData::HasByte | ( | const TCollection_ExtendedString & | theName | ) | const |
Returns true if the attribute contains this named byte.
| Standard_Boolean TDataStd_NamedData::HasBytes | ( | ) | const |
Returns true if there are some named bytes in the attribute.
| Standard_Boolean TDataStd_NamedData::HasInteger | ( | const TCollection_ExtendedString & | theName | ) | const |
Returns true if the attribute contains specified by Name integer value.
| Standard_Boolean TDataStd_NamedData::HasIntegers | ( | ) | const |
Returns true if at least one named integer value is kept in the attribute.
| Standard_Boolean TDataStd_NamedData::HasReal | ( | const TCollection_ExtendedString & | theName | ) | const |
Returns true if the attribute contains a real specified by Name.
| Standard_Boolean TDataStd_NamedData::HasReals | ( | ) | const |
Returns true if at least one named real value is kept in the attribute.
| Standard_Boolean TDataStd_NamedData::HasString | ( | const TCollection_ExtendedString & | theName | ) | const |
Returns true if the attribute contains this named string.
| Standard_Boolean TDataStd_NamedData::HasStrings | ( | ) | const |
Returns true if there are some named strings in the attribute.
|
overridevirtual |
Returns the ID of the attribute.
Implements TDF_Attribute.
|
overridevirtual |
Returns an new empty attribute from the good end type. It is used by the copy algorithm.
Implements TDF_Attribute.
|
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.
|
overridevirtual |
Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
Implements TDF_Attribute.
|
static |
Finds or creates a named data attribute.
| void TDataStd_NamedData::SetArrayOfIntegers | ( | const TCollection_ExtendedString & | theName, |
| const Handle< TColStd_HArray1OfInteger > & | theArrayOfIntegers | ||
| ) |
Defines a named array of integer values. If the array already exists, it changes its value to <theArrayOfIntegers>.
| void TDataStd_NamedData::SetArrayOfReals | ( | const TCollection_ExtendedString & | theName, |
| const Handle< TColStd_HArray1OfReal > & | theArrayOfReals | ||
| ) |
Defines a named array of real values. If the array already exists, it changes its value to <theArrayOfReals>.
| void TDataStd_NamedData::SetByte | ( | const TCollection_ExtendedString & | theName, |
| const Standard_Byte | theByte | ||
| ) |
Defines a named byte. If the byte already exists, it changes its value to <theByte>.
| void TDataStd_NamedData::SetInteger | ( | const TCollection_ExtendedString & | theName, |
| const Standard_Integer | theInteger | ||
| ) |
Defines a named integer. If the integer already exists, it changes its value to <theInteger>.
| void TDataStd_NamedData::SetReal | ( | const TCollection_ExtendedString & | theName, |
| const Standard_Real | theReal | ||
| ) |
Defines a named real. If the real already exists, it changes its value to <theReal>.
| void TDataStd_NamedData::SetString | ( | const TCollection_ExtendedString & | theName, |
| const TCollection_ExtendedString & | theString | ||
| ) |
Defines a named string. If the string already exists, it changes its value to <theString>.
The documentation for this class was generated from the following file:
