Open CASCADE Technology 7.8.0
Public Member Functions | Protected Member Functions
TDF_Delta Class Reference

A set of AttributeDelta for a given transaction number and reference time number. A delta set is available at <aSourceTime>. If applied, it restores the TDF_Data in the state it was at <aTargetTime>. More...

#include <TDF_Delta.hxx>

Inheritance diagram for TDF_Delta:
Inheritance graph
[legend]

Public Member Functions

 TDF_Delta ()
 Creates a delta.
 
Standard_Boolean IsEmpty () const
 Returns true if there is nothing to undo.
 
Standard_Boolean IsApplicable (const Standard_Integer aCurrentTime) const
 Returns true if the Undo action of <me> is applicable at <aCurrentTime>.
 
Standard_Integer BeginTime () const
 Returns the field <myBeginTime>.
 
Standard_Integer EndTime () const
 Returns the field <myEndTime>.
 
void Labels (TDF_LabelList &aLabelList) const
 Adds in <aLabelList> the labels of the attribute deltas. Caution: <aLabelList> is not cleared before use.
 
const TDF_AttributeDeltaListAttributeDeltas () const
 Returns the field <myAttDeltaList>.
 
TCollection_ExtendedString Name () const
 Returns a name associated with this delta.
 
void SetName (const TCollection_ExtendedString &theName)
 Associates a name <theName> with this delta.
 
void Dump (Standard_OStream &OS) const
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (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_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.
 
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.
 

Protected Member Functions

void Validity (const Standard_Integer aBeginTime, const Standard_Integer anEndTime)
 Validates <me> at <aBeginTime>. If applied, it restores the TDF_Data in the state it was at <anEndTime>. Reserved to TDF_Data.
 
void AddAttributeDelta (const Handle< TDF_AttributeDelta > &anAttributeDelta)
 Adds an AttributeDelta to the list. Reserved to TDF_Data.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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.
 

Detailed Description

A set of AttributeDelta for a given transaction number and reference time number. A delta set is available at <aSourceTime>. If applied, it restores the TDF_Data in the state it was at <aTargetTime>.

Constructor & Destructor Documentation

◆ TDF_Delta()

TDF_Delta::TDF_Delta ( )

Creates a delta.

Member Function Documentation

◆ AddAttributeDelta()

void TDF_Delta::AddAttributeDelta ( const Handle< TDF_AttributeDelta > &  anAttributeDelta)
protected

Adds an AttributeDelta to the list. Reserved to TDF_Data.

◆ AttributeDeltas()

const TDF_AttributeDeltaList & TDF_Delta::AttributeDeltas ( ) const

Returns the field <myAttDeltaList>.

◆ BeginTime()

Standard_Integer TDF_Delta::BeginTime ( ) const

Returns the field <myBeginTime>.

◆ Dump()

void TDF_Delta::Dump ( Standard_OStream OS) const

◆ DumpJson()

void TDF_Delta::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ EndTime()

Standard_Integer TDF_Delta::EndTime ( ) const

Returns the field <myEndTime>.

◆ IsApplicable()

Standard_Boolean TDF_Delta::IsApplicable ( const Standard_Integer  aCurrentTime) const

Returns true if the Undo action of <me> is applicable at <aCurrentTime>.

◆ IsEmpty()

Standard_Boolean TDF_Delta::IsEmpty ( ) const

Returns true if there is nothing to undo.

◆ Labels()

void TDF_Delta::Labels ( TDF_LabelList aLabelList) const

Adds in <aLabelList> the labels of the attribute deltas. Caution: <aLabelList> is not cleared before use.

◆ Name()

TCollection_ExtendedString TDF_Delta::Name ( ) const

Returns a name associated with this delta.

◆ SetName()

void TDF_Delta::SetName ( const TCollection_ExtendedString theName)

Associates a name <theName> with this delta.

◆ Validity()

void TDF_Delta::Validity ( const Standard_Integer  aBeginTime,
const Standard_Integer  anEndTime 
)
protected

Validates <me> at <aBeginTime>. If applied, it restores the TDF_Data in the state it was at <anEndTime>. Reserved to TDF_Data.


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