Contains a named data. More...

#include <TDataStd_NamedData.hxx>

Inheritance diagram for TDataStd_NamedData:

[legend]

Public Member Functions
	TDataStd_NamedData ()
	Empty constructor.

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

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

int	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 int theInteger)
	Defines a named integer. If the integer already exists, it changes its value to <theInteger>.

const NCollection_DataMap< TCollection_ExtendedString, int > &	GetIntegersContainer ()
	Returns the internal container of named integers.

void	ChangeIntegers (const NCollection_DataMap< TCollection_ExtendedString, int > &theIntegers)
	Replace the container content by new content of the <theIntegers>.

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

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

double	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 double theReal)
	Defines a named real. If the real already exists, it changes its value to <theReal>.

const NCollection_DataMap< TCollection_ExtendedString, double > &	GetRealsContainer ()
	Returns the internal container of named reals.

void	ChangeReals (const NCollection_DataMap< TCollection_ExtendedString, double > &theReals)
	Replace the container content by new content of the <theReals>.

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

bool	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 NCollection_DataMap< TCollection_ExtendedString, TCollection_ExtendedString > &	GetStringsContainer ()
	Returns the internal container of named strings.

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

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

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

uint8_t	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 uint8_t theByte)
	Defines a named byte. If the byte already exists, it changes its value to <theByte>.

const NCollection_DataMap< TCollection_ExtendedString, uint8_t > &	GetBytesContainer ()
	Returns the internal container of named bytes.

void	ChangeBytes (const NCollection_DataMap< TCollection_ExtendedString, uint8_t > &theBytes)
	Replace the container content by new content of the <theBytes>.

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

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

const occ::handle< NCollection_HArray1< int > > &	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 occ::handle< NCollection_HArray1< int > > &theArrayOfIntegers)
	Defines a named array of integer values.

const NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< int > > > &	GetArraysOfIntegersContainer ()
	Returns the internal container of named arrays of integer values.

void	ChangeArraysOfIntegers (const NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< int > > > &theArraysOfIntegers)
	Replace the container content by new content of the <theArraysOfIntegers>.

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

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

const occ::handle< NCollection_HArray1< double > > &	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 occ::handle< NCollection_HArray1< double > > &theArrayOfReals)
	Defines a named array of real values.

const NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< double > > > &	GetArraysOfRealsContainer ()
	Returns the internal container of named arrays of real values.

void	ChangeArraysOfReals (const NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< double > > > &theArraysOfReals)
	Replace the container content by new content of the <theArraysOfReals>.

void	Clear ()
	Clear data.

late-load deferred data interface
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);
virtual bool	HasDeferredData () const
	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 bool	LoadDeferredData (bool 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 bool	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 int theInteger)
	Defines a named integer (without calling Backup).

void	setReal (const TCollection_ExtendedString &theName, const double 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 uint8_t theByte)
	Defines a named byte (without calling Backup).

void	setArrayOfIntegers (const TCollection_ExtendedString &theName, const occ::handle< NCollection_HArray1< int > > &theArrayOfIntegers)
	Defines a named array of integer values (without calling Backup).

void	setArrayOfReals (const TCollection_ExtendedString &theName, const occ::handle< NCollection_HArray1< double > > &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.

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 occ::handle< TDF_DeltaOnModification >	DeltaOnModification (const occ::handle< TDF_Attribute > &anOldAttribute) const
	Makes a DeltaOnModification between <me> and.

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

static occ::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
occ::handle< TDataStd_HDataMapOfStringInteger >	myIntegers
	Dumps the content of me into the stream.

occ::handle< TDataStd_HDataMapOfStringReal >	myReals
	Dumps the content of me into the stream.

occ::handle< TDataStd_HDataMapOfStringString >	myStrings
	Dumps the content of me into the stream.

occ::handle< TDataStd_HDataMapOfStringByte >	myBytes
	Dumps the content of me into the stream.

occ::handle< TDataStd_HDataMapOfStringHArray1OfInteger >	myArraysOfIntegers
	Dumps the content of me into the stream.

occ::handle< TDataStd_HDataMapOfStringHArray1OfReal >	myArraysOfReals
	Dumps the content of me into the stream.

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

void	Restore (const occ::handle< TDF_Attribute > &With) override
	Dumps the content of me into the stream.

occ::handle< TDF_Attribute >	NewEmpty () const override
	Dumps the content of me into the stream.

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

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

void	DumpJson (Standard_OStream &theOStream, int 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 NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< int > > > & theArraysOfIntegers )

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

◆ ChangeArraysOfReals()

void TDataStd_NamedData::ChangeArraysOfReals ( const NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< double > > > & theArraysOfReals )

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

◆ ChangeBytes()

void TDataStd_NamedData::ChangeBytes ( const NCollection_DataMap< TCollection_ExtendedString, uint8_t > & theBytes )

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

◆ ChangeIntegers()

void TDataStd_NamedData::ChangeIntegers ( const NCollection_DataMap< TCollection_ExtendedString, int > & theIntegers )

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

◆ ChangeReals()

void TDataStd_NamedData::ChangeReals ( const NCollection_DataMap< TCollection_ExtendedString, double > & theReals )

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

◆ ChangeStrings()

void TDataStd_NamedData::ChangeStrings ( const NCollection_DataMap< TCollection_ExtendedString, TCollection_ExtendedString > & 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()

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

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Reimplemented from TDF_Attribute.

◆ GetArrayOfIntegers()

const occ::handle< NCollection_HArray1< int > > & 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 occ::handle< NCollection_HArray1< double > > & 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 NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< int > > > & TDataStd_NamedData::GetArraysOfIntegersContainer ( )

Returns the internal container of named arrays of integer values.

◆ GetArraysOfRealsContainer()

const NCollection_DataMap< TCollection_ExtendedString, occ::handle< NCollection_HArray1< double > > > & TDataStd_NamedData::GetArraysOfRealsContainer ( )

Returns the internal container of named arrays of real values.

◆ GetByte()

uint8_t 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 NCollection_DataMap< TCollection_ExtendedString, uint8_t > & 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()

int 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 NCollection_DataMap< TCollection_ExtendedString, int > & TDataStd_NamedData::GetIntegersContainer ( )

Returns the internal container of named integers.

◆ GetReal()

double 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 NCollection_DataMap< TCollection_ExtendedString, double > & 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 NCollection_DataMap< TCollection_ExtendedString, TCollection_ExtendedString > & TDataStd_NamedData::GetStringsContainer ( )

Returns the internal container of named strings.

◆ HasArrayOfIntegers()

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

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

◆ HasArrayOfReals()

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

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

◆ HasArraysOfIntegers()

bool TDataStd_NamedData::HasArraysOfIntegers ( ) const

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

◆ HasArraysOfReals()

bool TDataStd_NamedData::HasArraysOfReals ( ) const

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

◆ HasByte()

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

Returns true if the attribute contains this named byte.

◆ HasBytes()

bool TDataStd_NamedData::HasBytes ( ) const

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

◆ HasDeferredData()

virtual bool TDataStd_NamedData::HasDeferredData ( ) const

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

[in] theToKeepDeferred 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

◆ HasInteger()

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

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

◆ HasIntegers()

bool TDataStd_NamedData::HasIntegers ( ) const

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

◆ HasReal()

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

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

◆ HasReals()

bool TDataStd_NamedData::HasReals ( ) const

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

◆ HasString()

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

Returns true if the attribute contains this named string.

◆ HasStrings()

bool TDataStd_NamedData::HasStrings ( ) const

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

◆ ID()

const Standard_GUID & TDataStd_NamedData::ID ( ) const

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ LoadDeferredData()

virtual bool TDataStd_NamedData::LoadDeferredData ( bool 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

[in] theToKeepDeferred 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()

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

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ Paste()

void TDataStd_NamedData::Paste	(	const occ::handle< TDF_Attribute > &	Into,
		const occ::handle< TDF_RelocationTable > &	RT ) const

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ Restore()

void TDataStd_NamedData::Restore ( const occ::handle< TDF_Attribute > & With )

overridevirtual

Dumps the content of me into the stream.

Implements TDF_Attribute.

◆ Set()

static occ::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 occ::handle< NCollection_HArray1< int > > &	theArrayOfIntegers )

inline

Defines a named array of integer values.

Parameters

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

◆ setArrayOfIntegers()

void TDataStd_NamedData::setArrayOfIntegers	(	const TCollection_ExtendedString &	theName,
		const occ::handle< NCollection_HArray1< int > > &	theArrayOfIntegers )

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

◆ SetArrayOfReals()

void TDataStd_NamedData::SetArrayOfReals	(	const TCollection_ExtendedString &	theName,
		const occ::handle< NCollection_HArray1< double > > &	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 occ::handle< NCollection_HArray1< double > > &	theArrayOfReals )

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

◆ SetByte()

void TDataStd_NamedData::SetByte	(	const TCollection_ExtendedString &	theName,
		const uint8_t	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 uint8_t	theByte )

Defines a named byte (without calling Backup).

◆ SetInteger()

void TDataStd_NamedData::SetInteger	(	const TCollection_ExtendedString &	theName,
		const int	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 int	theInteger )

Defines a named integer (without calling Backup).

◆ SetReal()

void TDataStd_NamedData::SetReal	(	const TCollection_ExtendedString &	theName,
		const double	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 double	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 bool 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

occ::handle<TDataStd_HDataMapOfStringHArray1OfInteger> TDataStd_NamedData::myArraysOfIntegers

protected

Dumps the content of me into the stream.

◆ myArraysOfReals

occ::handle<TDataStd_HDataMapOfStringHArray1OfReal> TDataStd_NamedData::myArraysOfReals

protected

Dumps the content of me into the stream.

◆ myBytes

occ::handle<TDataStd_HDataMapOfStringByte> TDataStd_NamedData::myBytes

protected

Dumps the content of me into the stream.

◆ myIntegers

occ::handle<TDataStd_HDataMapOfStringInteger> TDataStd_NamedData::myIntegers

protected

Dumps the content of me into the stream.

◆ myReals

occ::handle<TDataStd_HDataMapOfStringReal> TDataStd_NamedData::myReals

protected

Dumps the content of me into the stream.

◆ myStrings

occ::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