Contains a named data. More...

#include <TDataStd_NamedData.hxx>

Inheritance diagram for TDataStd_NamedData:

[legend]

Public Member Functions
	TDataStd_NamedData ()
	Empty constructor.

Standard_Boolean	HasIntegers () const
	Returns true if at least one named integer value is kept in the attribute.

Standard_Boolean	HasInteger (const TCollection_ExtendedString &theName) const
	Returns true if the attribute contains specified by Name integer value.

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

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

const TColStd_DataMapOfStringInteger &	GetIntegersContainer ()
	Returns the internal container of named integers.

void	ChangeIntegers (const TColStd_DataMapOfStringInteger &theIntegers)
	Replace the container content by new content of the <theIntegers>.

Standard_Boolean	HasReals () const
	Returns true if at least one named real value is kept in the attribute.

Standard_Boolean	HasReal (const TCollection_ExtendedString &theName) const
	Returns true if the attribute contains a real specified by Name.

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()).

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

const TDataStd_DataMapOfStringReal &	GetRealsContainer ()
	Returns the internal container of named reals.

void	ChangeReals (const TDataStd_DataMapOfStringReal &theReals)
	Replace the container content by new content of the <theReals>.

Standard_Boolean	HasStrings () const
	Returns true if there are some named strings in the attribute.

Standard_Boolean	HasString (const TCollection_ExtendedString &theName) const
	Returns true if the attribute contains this named string.

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()).

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

const TDataStd_DataMapOfStringString &	GetStringsContainer ()
	Returns the internal container of named strings.

void	ChangeStrings (const TDataStd_DataMapOfStringString &theStrings)
	Replace the container content by new content of the <theStrings>.

Standard_Boolean	HasBytes () const
	Returns true if there are some named bytes in the attribute.

Standard_Boolean	HasByte (const TCollection_ExtendedString &theName) const
	Returns true if the attribute contains this named byte.

Standard_Byte	GetByte (const TCollection_ExtendedString &theName)
	Returns the named byte. It returns 0 if there is no such a named byte (use HasByte()).

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

const TDataStd_DataMapOfStringByte &	GetBytesContainer ()
	Returns the internal container of named bytes.

void	ChangeBytes (const TDataStd_DataMapOfStringByte &theBytes)
	Replace the container content by new content of the <theBytes>.

Standard_Boolean	HasArraysOfIntegers () const
	Returns true if there are some named arrays of integer values in the attribute.

Standard_Boolean	HasArrayOfIntegers (const TCollection_ExtendedString &theName) const
	Returns true if the attribute contains this named array of integer values.

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()).

void	SetArrayOfIntegers (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfInteger > &theArrayOfIntegers)
	Defines a named array of integer values.

const TDataStd_DataMapOfStringHArray1OfInteger &	GetArraysOfIntegersContainer ()
	Returns the internal container of named arrays of integer values.

void	ChangeArraysOfIntegers (const TDataStd_DataMapOfStringHArray1OfInteger &theArraysOfIntegers)
	Replace the container content by new content of the <theArraysOfIntegers>.

Standard_Boolean	HasArraysOfReals () const
	Returns true if there are some named arrays of real values in the attribute.

Standard_Boolean	HasArrayOfReals (const TCollection_ExtendedString &theName) const
	Returns true if the attribute contains this named array of real values.

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()).

void	SetArrayOfReals (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfReal > &theArrayOfReals)
	Defines a named array of real values.

const TDataStd_DataMapOfStringHArray1OfReal &	GetArraysOfRealsContainer ()
	Returns the internal container of named arrays of real values.

void	ChangeArraysOfReals (const TDataStd_DataMapOfStringHArray1OfReal &theArraysOfReals)
	Replace the container content by new content of the <theArraysOfReals>.

void	Clear ()
	Clear data.

late-load deferred data interface
virtual Standard_Boolean	HasDeferredData () const
	Returns TRUE if some data is not loaded from deferred storage and can be loaded using LoadDeferredData().

virtual Standard_Boolean	LoadDeferredData (Standard_Boolean theToKeepDeferred=false)
	Load data from deferred storage, without calling Backup(). As result, the content of the object will be overridden by data from deferred storage (which is normally read-only).

virtual Standard_Boolean	UnloadDeferredData ()
	Releases data if object has connected deferred storage, without calling Backup(). WARNING! This operation does not unload modifications to deferred storage (normally it is read-only), so that modifications will be discarded (if any).

void	clear ()
	Clear data without calling Backup().

void	setInteger (const TCollection_ExtendedString &theName, const Standard_Integer theInteger)
	Defines a named integer (without calling Backup).

void	setReal (const TCollection_ExtendedString &theName, const Standard_Real theReal)
	Defines a named real (without calling Backup).

void	setString (const TCollection_ExtendedString &theName, const TCollection_ExtendedString &theString)
	Defines a named string (without calling Backup).

void	setByte (const TCollection_ExtendedString &theName, const Standard_Byte theByte)
	Defines a named byte (without calling Backup).

void	setArrayOfIntegers (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfInteger > &theArrayOfIntegers)
	Defines a named array of integer values (without calling Backup).

void	setArrayOfReals (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfReal > &theArrayOfReals)
	Defines a named array of real values (without calling Backup).

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.

virtual void	References (const 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, 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".

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 ID of the named data attribute.

static Handle< TDataStd_NamedData >	Set (const TDF_Label &label)
	Finds or creates a named data attribute.

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.

TDF_Attribute interface
Handle< TDataStd_HDataMapOfStringInteger >	myIntegers
	Dumps the content of me into the stream.

Handle< TDataStd_HDataMapOfStringReal >	myReals
	Dumps the content of me into the stream.

Handle< TDataStd_HDataMapOfStringString >	myStrings
	Dumps the content of me into the stream.

Handle< TDataStd_HDataMapOfStringByte >	myBytes
	Dumps the content of me into the stream.

Handle< TDataStd_HDataMapOfStringHArray1OfInteger >	myArraysOfIntegers
	Dumps the content of me into the stream.

Handle< TDataStd_HDataMapOfStringHArray1OfReal >	myArraysOfReals
	Dumps the content of me into the stream.

virtual const Standard_GUID &	ID () const override
	Dumps the content of me into the stream.

virtual void	Restore (const Handle< TDF_Attribute > &With) override
	Dumps the content of me into the stream.

virtual Handle< TDF_Attribute >	NewEmpty () const override
	Dumps the content of me into the stream.

virtual void	Paste (const Handle< TDF_Attribute > &Into, const Handle< TDF_RelocationTable > &RT) const override
	Dumps the content of me into the stream.

virtual Standard_OStream &	Dump (Standard_OStream &anOS) const override
	Dumps the content of me into the stream.

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

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

Contains a named data.

Constructor & Destructor Documentation

◆ TDataStd_NamedData()

TDataStd_NamedData::TDataStd_NamedData ( )

Empty constructor.

Member Function Documentation

◆ ChangeArraysOfIntegers()

void TDataStd_NamedData::ChangeArraysOfIntegers ( const TDataStd_DataMapOfStringHArray1OfInteger & theArraysOfIntegers )

Replace the container content by new content of the <theArraysOfIntegers>.

◆ ChangeArraysOfReals()

void TDataStd_NamedData::ChangeArraysOfReals ( const TDataStd_DataMapOfStringHArray1OfReal & theArraysOfReals )

Replace the container content by new content of the <theArraysOfReals>.

◆ ChangeBytes()

void TDataStd_NamedData::ChangeBytes ( const TDataStd_DataMapOfStringByte & theBytes )

Replace the container content by new content of the <theBytes>.

◆ ChangeIntegers()

void TDataStd_NamedData::ChangeIntegers ( const TColStd_DataMapOfStringInteger & theIntegers )

Replace the container content by new content of the <theIntegers>.

◆ ChangeReals()

void TDataStd_NamedData::ChangeReals ( const TDataStd_DataMapOfStringReal & theReals )

Replace the container content by new content of the <theReals>.

◆ ChangeStrings()

void TDataStd_NamedData::ChangeStrings ( const TDataStd_DataMapOfStringString & theStrings )

Replace the container content by new content of the <theStrings>.

◆ Clear()

void TDataStd_NamedData::Clear ( )

inline

Clear data.

◆ clear()

void TDataStd_NamedData::clear ( )

Clear data without calling Backup().

◆ Dump()

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

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ DumpJson()

virtual void TDataStd_NamedData::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ GetArrayOfIntegers()

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()).

◆ GetArrayOfReals()

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()).

◆ GetArraysOfIntegersContainer()

const TDataStd_DataMapOfStringHArray1OfInteger & TDataStd_NamedData::GetArraysOfIntegersContainer ( )

Returns the internal container of named arrays of integer values.

◆ GetArraysOfRealsContainer()

const TDataStd_DataMapOfStringHArray1OfReal & TDataStd_NamedData::GetArraysOfRealsContainer ( )

Returns the internal container of named arrays of real values.

◆ GetByte()

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()).

◆ GetBytesContainer()

const TDataStd_DataMapOfStringByte & TDataStd_NamedData::GetBytesContainer ( )

Returns the internal container of named bytes.

◆ GetID()

static const Standard_GUID & TDataStd_NamedData::GetID ( )

static

Returns the ID of the named data attribute.

◆ GetInteger()

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

◆ GetIntegersContainer()

const TColStd_DataMapOfStringInteger & TDataStd_NamedData::GetIntegersContainer ( )

Returns the internal container of named integers.

◆ GetReal()

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()).

◆ GetRealsContainer()

const TDataStd_DataMapOfStringReal & TDataStd_NamedData::GetRealsContainer ( )

Returns the internal container of named reals.

◆ GetString()

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()).

◆ GetStringsContainer()

const TDataStd_DataMapOfStringString & TDataStd_NamedData::GetStringsContainer ( )

Returns the internal container of named strings.

◆ HasArrayOfIntegers()

Standard_Boolean TDataStd_NamedData::HasArrayOfIntegers ( const TCollection_ExtendedString & theName ) const

Returns true if the attribute contains this named array of integer values.

◆ HasArrayOfReals()

Standard_Boolean TDataStd_NamedData::HasArrayOfReals ( const TCollection_ExtendedString & theName ) const

Returns true if the attribute contains this named array of real values.

◆ HasArraysOfIntegers()

Standard_Boolean TDataStd_NamedData::HasArraysOfIntegers ( ) const

Returns true if there are some named arrays of integer values in the attribute.

◆ HasArraysOfReals()

Standard_Boolean TDataStd_NamedData::HasArraysOfReals ( ) const

Returns true if there are some named arrays of real values in the attribute.

◆ HasByte()

Standard_Boolean TDataStd_NamedData::HasByte ( const TCollection_ExtendedString & theName ) const

Returns true if the attribute contains this named byte.

◆ HasBytes()

Standard_Boolean TDataStd_NamedData::HasBytes ( ) const

Returns true if there are some named bytes in the attribute.

◆ HasDeferredData()

virtual Standard_Boolean TDataStd_NamedData::HasDeferredData ( ) const

inlinevirtual

Returns TRUE if some data is not loaded from deferred storage and can be loaded using LoadDeferredData().

Late-load interface allows to avoid loading auxiliary data into memory until it is needed by application and also speed up reader by skipping data chunks in file. This feature requires file format having special structure, and usually implies read-only access, therefore default implementation will return FALSE here.

Late-load elements require special attention to ensure data consistency, as such elements are created in undefined state (no data) and Undo/Redo mechanism will not work until deferred data being loaded.

Usage scenarios:

Application displays model in read-only way. Late-load elements are loaded temporarily on demand and immediately unloaded. theNamedData->LoadDeferredData (true); TCollection_AsciiString aValue = theNamedData->GetString (theKey); theNamedData->UnloadDeferredData();
Application saves the model into another format. All late-load elements should be loaded (at least temporary during operation).
Application modifies the model. Late-load element should be loaded with removed link to deferred storage, so that Undo()/Redo() will work as expected since loading. theNamedData->LoadDeferredData (false); theNamedData->SetString (theKey, theNewValue);

◆ HasInteger()

Standard_Boolean TDataStd_NamedData::HasInteger ( const TCollection_ExtendedString & theName ) const

Returns true if the attribute contains specified by Name integer value.

◆ HasIntegers()

Standard_Boolean TDataStd_NamedData::HasIntegers ( ) const

Returns true if at least one named integer value is kept in the attribute.

◆ HasReal()

Standard_Boolean TDataStd_NamedData::HasReal ( const TCollection_ExtendedString & theName ) const

Returns true if the attribute contains a real specified by Name.

◆ HasReals()

Standard_Boolean TDataStd_NamedData::HasReals ( ) const

Returns true if at least one named real value is kept in the attribute.

◆ HasString()

Standard_Boolean TDataStd_NamedData::HasString ( const TCollection_ExtendedString & theName ) const

Returns true if the attribute contains this named string.

◆ HasStrings()

Standard_Boolean TDataStd_NamedData::HasStrings ( ) const

Returns true if there are some named strings in the attribute.

◆ ID()

virtual const Standard_GUID & TDataStd_NamedData::ID ( ) const

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ LoadDeferredData()

virtual Standard_Boolean TDataStd_NamedData::LoadDeferredData ( Standard_Boolean theToKeepDeferred = false )

inlinevirtual

Load data from deferred storage, without calling Backup(). As result, the content of the object will be overridden by data from deferred storage (which is normally read-only).

Parameters

theToKeepDeferred [in] when TRUE, the link to deferred storage will be preserved so that it will be possible calling UnloadDeferredData() afterwards for releasing memory

Returns: FALSE if deferred storage is unavailable or deferred data has been already loaded

◆ NewEmpty()

virtual Handle< TDF_Attribute > TDataStd_NamedData::NewEmpty ( ) const

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ Paste()

virtual void TDataStd_NamedData::Paste	(	const Handle< TDF_Attribute > &	Into,
		const Handle< TDF_RelocationTable > &	RT
	)		const

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ Restore()

virtual void TDataStd_NamedData::Restore ( const Handle< TDF_Attribute > & With )

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ Set()

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

static

Finds or creates a named data attribute.

◆ SetArrayOfIntegers()

void TDataStd_NamedData::SetArrayOfIntegers	(	const TCollection_ExtendedString &	theName,
		const Handle< TColStd_HArray1OfInteger > &	theArrayOfIntegers
	)

inline

Defines a named array of integer values.

Parameters

theName	[in] key
theArrayOfIntegers	[in] new value, overrides existing (passed array will be copied by value!)

◆ setArrayOfIntegers()

void TDataStd_NamedData::setArrayOfIntegers	(	const TCollection_ExtendedString &	theName,
		const Handle< TColStd_HArray1OfInteger > &	theArrayOfIntegers
	)

Defines a named array of integer values (without calling Backup).

◆ SetArrayOfReals()

void TDataStd_NamedData::SetArrayOfReals	(	const TCollection_ExtendedString &	theName,
		const Handle< TColStd_HArray1OfReal > &	theArrayOfReals
	)

inline

Defines a named array of real values.

Parameters

[in]	theName	key
[in]	theArrayOfReals	new value, overrides existing (passed array will be copied by value!)

◆ setArrayOfReals()

void TDataStd_NamedData::setArrayOfReals	(	const TCollection_ExtendedString &	theName,
		const Handle< TColStd_HArray1OfReal > &	theArrayOfReals
	)

Defines a named array of real values (without calling Backup).

◆ SetByte()

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

◆ setByte()

void TDataStd_NamedData::setByte	(	const TCollection_ExtendedString &	theName,
		const Standard_Byte	theByte
	)

Defines a named byte (without calling Backup).

◆ SetInteger()

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

◆ setInteger()

void TDataStd_NamedData::setInteger	(	const TCollection_ExtendedString &	theName,
		const Standard_Integer	theInteger
	)

Defines a named integer (without calling Backup).

◆ SetReal()

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

◆ setReal()

void TDataStd_NamedData::setReal	(	const TCollection_ExtendedString &	theName,
		const Standard_Real	theReal
	)

Defines a named real (without calling Backup).

◆ SetString()

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

◆ setString()

void TDataStd_NamedData::setString	(	const TCollection_ExtendedString &	theName,
		const TCollection_ExtendedString &	theString
	)

Defines a named string (without calling Backup).

◆ UnloadDeferredData()

virtual Standard_Boolean TDataStd_NamedData::UnloadDeferredData ( )

inlinevirtual

Releases data if object has connected deferred storage, without calling Backup(). WARNING! This operation does not unload modifications to deferred storage (normally it is read-only), so that modifications will be discarded (if any).

Returns: FALSE if object has no deferred data

Field Documentation

◆ myArraysOfIntegers

Handle< TDataStd_HDataMapOfStringHArray1OfInteger > TDataStd_NamedData::myArraysOfIntegers

protected

Dumps the content of me into the stream.

◆ myArraysOfReals

Handle< TDataStd_HDataMapOfStringHArray1OfReal > TDataStd_NamedData::myArraysOfReals

protected

Dumps the content of me into the stream.

◆ myBytes

Handle< TDataStd_HDataMapOfStringByte > TDataStd_NamedData::myBytes

protected

Dumps the content of me into the stream.

◆ myIntegers

Handle< TDataStd_HDataMapOfStringInteger > TDataStd_NamedData::myIntegers

protected

Dumps the content of me into the stream.

◆ myReals

Handle< TDataStd_HDataMapOfStringReal > TDataStd_NamedData::myReals

protected

Dumps the content of me into the stream.

◆ myStrings

Handle< TDataStd_HDataMapOfStringString > TDataStd_NamedData::myStrings

protected

Dumps the content of me into the stream.

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

TDataStd_NamedData.hxx

Public Member Functions

Static Public Member Functions

TDF_Attribute interface

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TDataStd_NamedData()

Member Function Documentation

◆ ChangeArraysOfIntegers()

◆ ChangeArraysOfReals()

◆ ChangeBytes()

◆ ChangeIntegers()

◆ ChangeReals()

◆ ChangeStrings()

◆ Clear()

◆ clear()

◆ Dump()

◆ DumpJson()

◆ GetArrayOfIntegers()

◆ GetArrayOfReals()

◆ GetArraysOfIntegersContainer()

◆ GetArraysOfRealsContainer()

◆ GetByte()

◆ GetBytesContainer()

◆ GetID()

◆ GetInteger()

◆ GetIntegersContainer()

◆ GetReal()

◆ GetRealsContainer()

◆ GetString()

◆ GetStringsContainer()

◆ HasArrayOfIntegers()

◆ HasArrayOfReals()

◆ HasArraysOfIntegers()

◆ HasArraysOfReals()

◆ HasByte()

◆ HasBytes()

◆ HasDeferredData()

◆ HasInteger()

◆ HasIntegers()

◆ HasReal()

◆ HasReals()

◆ HasString()

◆ HasStrings()

◆ ID()

◆ LoadDeferredData()

◆ NewEmpty()

◆ Paste()

◆ Restore()

◆ Set()

◆ SetArrayOfIntegers()

◆ setArrayOfIntegers()

◆ SetArrayOfReals()

◆ setArrayOfReals()

◆ SetByte()

◆ setByte()

◆ SetInteger()

◆ setInteger()

◆ SetReal()

◆ setReal()

◆ SetString()

◆ setString()

◆ UnloadDeferredData()

Field Documentation

◆ myArraysOfIntegers

◆ myArraysOfReals

◆ myBytes

◆ myIntegers

◆ myReals

◆ myStrings