Open CASCADE Technology  7.4.1.dev
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions
TObj_Object Class Reference

Basis class for transient objects in OCAF-based models. More...

#include <TObj_Object.hxx>

Inheritance diagram for TObj_Object:
Inheritance graph
[legend]

Public Types

enum  TypeFlags { Visible = 0x0001 }
 < Flags that define type-specific behaviour of objects More...
 
enum  ObjectState {
  ObjectState_Hidden = 0x0001, ObjectState_Saved = 0x0002, ObjectState_Imported = 0x0004, ObjectState_ImportedByFile = 0x0008,
  ObjectState_Ordered = 0x0010
}
 enumeration describing various object state bit flags (see Set/GetFlags()) More...
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

virtual Handle< TObj_ModelGetModel () const
 Returns the model to which the object belongs. More...
 
virtual Handle< TObj_ObjectIteratorGetChildren (const Handle< Standard_Type > &theType=NULL) const
 Returns iterator for the child objects. This method provides tree-like view of the objects hierarchy. The references to other objects are not considered as children. theType narrows a variety of iterated objects The default implementation search for children on 1 sublavel of the children sub label. More...
 
TDF_Label GetChildLabel () const
 Returns the label under which children are stored. More...
 
TDF_Label getChildLabel (const Standard_Integer theRank) const
 Returns the label for child with rank. More...
 
TDF_Label GetLabel () const
 Returns the OCAF label on which object`s data are stored. More...
 
TDF_Label GetDataLabel () const
 Returns the label which is the root for data OCAF sub-tree. More...
 
TDF_Label GetReferenceLabel () const
 Returns the label which is the root for reference OCAF sub-tree. More...
 
virtual Handle< TObj_TNameContainerGetDictionary () const
 Returns the map of names of the objects Default implementation returns global Dictionary of the model. More...
 
virtual Handle< TCollection_HExtendedStringGetName () const
 Returns the name of the object (empty string if object has no name) More...
 
Standard_Boolean GetName (TCollection_ExtendedString &theName) const
 Returns the Standard_True is object has name and returns name to theName. More...
 
Standard_Boolean GetName (TCollection_AsciiString &theName) const
 Returns the Standard_True is object has name and returns name to theName. More...
 
virtual Standard_Boolean SetName (const Handle< TCollection_HExtendedString > &theName) const
 Sets name of the object. Returns False if theName is not unique. More...
 
Standard_Boolean SetName (const Handle< TCollection_HAsciiString > &theName) const
 Sets name of the object. Returns False if theName is not unique. More...
 
Standard_Boolean SetName (const Standard_CString name) const
 Sets name of the object. Returns False if theName is not unique. More...
 
virtual Handle< TCollection_HExtendedStringGetNameForClone (const Handle< TObj_Object > &) const
 Returns name for copy default implementation returns the same name. More...
 
virtual Standard_Boolean HasReference (const Handle< TObj_Object > &theObject) const
 Returns True if object has reference to indicated object. More...
 
virtual Handle< TObj_ObjectIteratorGetReferences (const Handle< Standard_Type > &theType=NULL) const
 Returns an Iterator containing objects that compose the this one theType narrows a variety of iterated objects. More...
 
virtual void RemoveAllReferences ()
 Remove all references to other objects, by removing all reference attributes. More...
 
virtual Handle< TObj_ObjectIteratorGetBackReferences (const Handle< Standard_Type > &theType=NULL) const
 Returns iterator for the objects which depend on this one. These reffering objects may belong to other models. theType narrows a variety of iterated objects. More...
 
virtual void AddBackReference (const Handle< TObj_Object > &theObject)
 Registers another object as being dependent on this one. Stores back references under sublabel 2 (purely transient data, not subject to persistency). More...
 
virtual void RemoveBackReference (const Handle< TObj_Object > &theObject, const Standard_Boolean theSingleOnly=Standard_True)
 Removes information on dependent object (back reference). If theSingleOnly is true only the first back reference is removed in the case of duplicate items. More...
 
virtual Standard_Boolean RemoveBackReferences (const TObj_DeletingMode theMode=TObj_FreeOnly)
 Removes all back reference by removing references from other to me. More...
 
virtual void ClearBackReferences ()
 The default implementation just clear the back references container. More...
 
Standard_Boolean HasBackReferences () const
 Returns TRUE if obejct has 1 or more back references. More...
 
virtual void ReplaceReference (const Handle< TObj_Object > &theOldObject, const Handle< TObj_Object > &theNewObject)
 Replace reference from old object to new object. If it is not possible, may raise exception. If new object is null then simple remove reference to old object. More...
 
virtual Standard_Boolean GetBadReference (const TDF_Label &theRoot, TDF_Label &theBadReference) const
 Return True if this refers to the model theRoot belongs to and a referred label is not a descendant of theRoot. In this case theBadReference returns the currently referred label. More...
 
virtual Standard_Boolean RelocateReferences (const TDF_Label &theFromRoot, const TDF_Label &theToRoot, const Standard_Boolean theUpdateBackRefs=Standard_True)
 Make that each reference pointing to a descendant label of theFromRoot to point to an equivalent label under theToRoot. Return False if a resulting reference does not point to an TObj_Object Example: a referred object label = 0:3:24:7:2:7 theFromRoot = 0:3:24 theToRoot = 0:2 a new referred label = 0:2:7:2:7. More...
 
virtual Standard_Boolean CanRemoveReference (const Handle< TObj_Object > &theObject) const
 Returns True if the referred object theObject can be deleted without deletion of this object. Default implementation does nothing and returns False. More...
 
virtual void RemoveReference (const Handle< TObj_Object > &theObject)
 Removes reference to the object by replace reference to NULL object. More...
 
virtual void BeforeForgetReference (const TDF_Label &)
 Invokes from TObj_TReference::BeforeForget(). theLabel - label on that reference become removed Default implementation is empty. More...
 
virtual Standard_Boolean CanDetach (const TObj_DeletingMode theMode=TObj_FreeOnly)
 Checks if object can be detached with specified mode. More...
 
virtual Standard_Boolean Detach (const TObj_DeletingMode theMode=TObj_FreeOnly)
 Deletes the object from the model. The dependent objects are either deleted or modified when possible (see description of TObj_DeletingMode enumeration for more details) Returns True if deletion was successful. Checks if object can be deleted. Should be redefined for each specific kind of object. More...
 
Handle< TObj_ObjectGetFatherObject (const Handle< Standard_Type > &theType=NULL) const
 Returns the father object, which may be NULL theType gives type of father object to search. More...
 
virtual Standard_Boolean IsAlive () const
 Checks that object alive in model Default implementation checks that object has TObject attribute at own label. More...
 
virtual Handle< TObj_ObjectClone (const TDF_Label &theTargetLabel, Handle< TDF_RelocationTable > theRelocTable=0)
 Copy me to other label theTargetLabel New object will not have all the reference that has me. Coping object with data and childs, but change name by adding string "_copy" As result return handle of new object (null handle is something wrong) NOTE: BackReferences not coping. After clonning all objects it is neccessary to call copy references with the same relocation table. More...
 
virtual void CopyReferences (const Handle< TObj_Object > &theTargetObject, const Handle< TDF_RelocationTable > &theRelocTable)
 Coping the references. return Standard_False is Target object is different type. More...
 
virtual void CopyChildren (TDF_Label &theTargetLabel, const Handle< TDF_RelocationTable > &theRelocTable)
 Coping the children from source label to the target. More...
 
virtual Standard_Integer GetOrder () const
 returns order of object (or tag of their label if order is not initialised) More...
 
virtual Standard_Boolean SetOrder (const Standard_Integer &theIndx)
 sets order of object More...
 
virtual Standard_Integer GetTypeFlags () const
 Returns flags (bitmask) that define properties of objects of that type By default returns flag Visible. More...
 
Standard_Integer GetFlags () const
 Returns mask of seted flags. More...
 
void SetFlags (const Standard_Integer theMask)
 Sets flags with defined mask. More...
 
Standard_Boolean TestFlags (const Standard_Integer theMask) const
 tests flags by the mask. More...
 
void ClearFlags (const Standard_Integer theMask=~0)
 clears flags by the mask. More...
 
virtual void AfterRetrieval ()
 Preforms updating the links and dependances of the object which are not stored in persistence. Should be redefined if necessary. More...
 
virtual void BeforeStoring ()
 Preforms storing the objects transient fields in OCAF document which were outside transaction mechanism. Default implementation doesnot nothing. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static Standard_Boolean Detach (const TDF_Label &theLabel, const TObj_DeletingMode theMode=TObj_FreeOnly)
 Deletes the object from the label. Checks if object can be deleted. Finds object on the label and detaches it by calling previos method. Returns true if there is no object on the label after detaching. More...
 
static Standard_Boolean GetObj (const TDF_Label &theLabel, Handle< TObj_Object > &theResult, const Standard_Boolean isSuper=Standard_False)
 Returns the Object attached to a given label. Returns False if no object of type TObj_Object is stored on the specified label. If isSuper is true tries to find on the super labels. 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...
 

Protected Types

enum  DataTag { DataTag_First = 0, DataTag_Flags, DataTag_Order, DataTag_Last = DataTag_First + 100 }
 enumeration for the ranks of label under Data section. More...
 
enum  ChildTag { ChildTag_First = 0, ChildTag_Last = ChildTag_First }
 enumeration for the ranks of label under Child section. More...
 
enum  RefTag { RefTag_First = 0, RefTag_Last = RefTag_First }
 enumeration for the ranks of label under Reference section. More...
 

Protected Member Functions

 TObj_Object (const TDF_Label &theLabel, const Standard_Boolean theSetName=Standard_True)
 Constructor of a new object interface: requires label, which should be one of the labels in model's data structure. This creates a new object and attaches it to a given label. The initialisation of the object's data and their integrity is to be ensured by implementations and by persistence mechanism. If the flag theSetName is true (default) the object is assign the default name that is generated using the father partition object if any. More...
 
 TObj_Object (const TObj_Persistence *, const TDF_Label &theLabel)
 The special constructor intended for implementation of persistence mechanism. See class TObj_Persistence for more details. The first argument is used only to avoid confusion with other constructors. More...
 
void initFields ()
 This method is called from persistence to initialize the object fields, so successors that have transient fields must initialize them in initFields(), and call the same method of parent. More...
 
virtual Standard_Boolean copyData (const Handle< TObj_Object > &theTargetObject)
 Coping the data of me to Target object. return Standard_False is Target object is different type. More...
 
void copyReferences (const TDF_Label &theSourceLabel, TDF_Label &theTargetLabel, const Handle< TDF_RelocationTable > &theRelocTable)
 Coping the references from source label to the target. More...
 
TDF_Label getDataLabel (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the theRank2-th sub label of the theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), sub label theRank1 of Data label is returned. If requested label does not exist, it is created. More...
 
TDF_Label getReferenceLabel (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the theRank2-th sub label of the theRank1-th sublabel of the Reference label of the object. If theRank2 is 0 (default), sub label theRank1 of Reference label is returned. If requested label does not exist, it is created. More...
 
Standard_Boolean isDataAttribute (const Standard_GUID &theGUID, const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns True if there is an attribute having theGUID on the theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed, not its sublabel. More...
 
Standard_Real getReal (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the real value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns 0.0 if no real value is stored on that label. More...
 
Standard_Boolean setReal (const Standard_Real theValue, const Standard_Integer theRank1, const Standard_Integer theRank2=0, const Standard_Real theTolerance=0.) const
 Sets the real value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns True if new value is actually different from previous one (with specified tolerance) More...
 
Standard_Integer getInteger (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the integer value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns 0 if no integer value is stored on that label. More...
 
Standard_Boolean setInteger (const Standard_Integer theValue, const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Sets the integer value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns True if new value is actually different from previous one. More...
 
Handle< TColStd_HArray1OfReal > getRealArray (const Standard_Integer theLength, const Standard_Integer theRank1, const Standard_Integer theRank2=0, const Standard_Real theInitialValue=0.0) const
 Returns an existing or create a new real array on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). A newly created array has 1 and theLength bounds and is initialized with theInitialValue. More...
 
Handle< TColStd_HArray1OfInteger > getIntegerArray (const Standard_Integer theLength, const Standard_Integer theRank1, const Standard_Integer theRank2=0, const Standard_Integer theInitialValue=0) const
 Returns an existing or create a new integer array on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). A newly created array has 1 and theLength bounds and is initialized with theInitialValue. More...
 
Handle< TColStd_HArray1OfExtendedString > getExtStringArray (const Standard_Integer theLength, const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns an existing or create a new string array on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). A newly created array has 1 and theLength bounds NOTE: new created array is NOT initialized. More...
 
void setArray (const Handle< TColStd_HArray1OfReal > &theArray, const Standard_Integer theRank1, const Standard_Integer theRank2=0)
 Store theArray on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). If theArray is null then array attribute if any is removed. More...
 
void setArray (const Handle< TColStd_HArray1OfInteger > &theArray, const Standard_Integer theRank1, const Standard_Integer theRank2=0)
 Store theArray on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). If theArray is null then array attribute if any is removed. More...
 
void setArray (const Handle< TColStd_HArray1OfExtendedString > &theArray, const Standard_Integer theRank1, const Standard_Integer theRank2=0)
 Store theArray on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). If theArray is null then array attribute if any is removed. More...
 
void setExtString (const Handle< TCollection_HExtendedString > &theValue, const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Sets the string value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). More...
 
Handle< TCollection_HExtendedStringgetExtString (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the string value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). More...
 
void setAsciiString (const Handle< TCollection_HAsciiString > &theValue, const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Sets the ascii string value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). More...
 
Handle< TCollection_HAsciiStringgetAsciiString (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the string value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). More...
 
Handle< TObj_ObjectgetReference (const Standard_Integer theRank1, const Standard_Integer theRank2=0) const
 Returns the reference attribute from theRank2-th sublabel of theRank1-th sublabel of the References label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). More...
 
Standard_Boolean setReference (const Handle< TObj_Object > &theObject, const Standard_Integer theRank1, const Standard_Integer theRank2=0)
 Sets the reference to theObject on theRank2-th sublabel of theRank1-th sublabel of the References label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns True if new value is actually different from previous one If Object is NULL, reference is deleted. More...
 
TDF_Label addReference (const Standard_Integer theRank1, const Handle< TObj_Object > &theObject)
 Adds the reference to theObject on next free sublabel of theRank1-th sublabel of the References label of the object and returns the Label. More...
 

Detailed Description

Basis class for transient objects in OCAF-based models.

Member Enumeration Documentation

◆ ChildTag

enum TObj_Object::ChildTag
protected

enumeration for the ranks of label under Child section.

Enumerator
ChildTag_First 
ChildTag_Last 

No children.

◆ DataTag

enum TObj_Object::DataTag
protected

enumeration for the ranks of label under Data section.

Enumerator
DataTag_First 
DataTag_Flags 

stores flags of object

DataTag_Order 

stores order of object

DataTag_Last 

Reserved for possible future use.

◆ ObjectState

enumeration describing various object state bit flags (see Set/GetFlags())

Enumerator
ObjectState_Hidden 

object is hidden in tree browser

ObjectState_Saved 

object has (or should have) corresponding saved file on disk

ObjectState_Imported 

object's data are just imported from somewhere

ObjectState_ImportedByFile 

a model imported by file may need a sophisticated update of external references

ObjectState_Ordered 

flag that partition contains ordered objects

◆ RefTag

enum TObj_Object::RefTag
protected

enumeration for the ranks of label under Reference section.

Enumerator
RefTag_First 
RefTag_Last 

No children.

◆ TypeFlags

< Flags that define type-specific behaviour of objects

Enumerator
Visible 

Is visible in DataViewer.

Constructor & Destructor Documentation

◆ TObj_Object() [1/2]

TObj_Object::TObj_Object ( const TDF_Label theLabel,
const Standard_Boolean  theSetName = Standard_True 
)
protected

Constructor of a new object interface: requires label, which should be one of the labels in model's data structure. This creates a new object and attaches it to a given label. The initialisation of the object's data and their integrity is to be ensured by implementations and by persistence mechanism. If the flag theSetName is true (default) the object is assign the default name that is generated using the father partition object if any.

Constructors

◆ TObj_Object() [2/2]

TObj_Object::TObj_Object ( const TObj_Persistence ,
const TDF_Label theLabel 
)
inlineprotected

The special constructor intended for implementation of persistence mechanism. See class TObj_Persistence for more details. The first argument is used only to avoid confusion with other constructors.

Member Function Documentation

◆ AddBackReference()

virtual void TObj_Object::AddBackReference ( const Handle< TObj_Object > &  theObject)
virtual

Registers another object as being dependent on this one. Stores back references under sublabel 2 (purely transient data, not subject to persistency).

◆ addReference()

TDF_Label TObj_Object::addReference ( const Standard_Integer  theRank1,
const Handle< TObj_Object > &  theObject 
)
protected

Adds the reference to theObject on next free sublabel of theRank1-th sublabel of the References label of the object and returns the Label.

◆ AfterRetrieval()

virtual void TObj_Object::AfterRetrieval ( )
virtual

Preforms updating the links and dependances of the object which are not stored in persistence. Should be redefined if necessary.

Method for updating object afrer restoring

Reimplemented in TObj_Partition.

◆ BeforeForgetReference()

virtual void TObj_Object::BeforeForgetReference ( const TDF_Label )
inlinevirtual

Invokes from TObj_TReference::BeforeForget(). theLabel - label on that reference become removed Default implementation is empty.

◆ BeforeStoring()

virtual void TObj_Object::BeforeStoring ( )
virtual

Preforms storing the objects transient fields in OCAF document which were outside transaction mechanism. Default implementation doesnot nothing.

◆ CanDetach()

virtual Standard_Boolean TObj_Object::CanDetach ( const TObj_DeletingMode  theMode = TObj_FreeOnly)
virtual

Checks if object can be detached with specified mode.

Methods for deleting the object

◆ CanRemoveReference()

virtual Standard_Boolean TObj_Object::CanRemoveReference ( const Handle< TObj_Object > &  theObject) const
virtual

Returns True if the referred object theObject can be deleted without deletion of this object. Default implementation does nothing and returns False.

◆ ClearBackReferences()

virtual void TObj_Object::ClearBackReferences ( )
virtual

The default implementation just clear the back references container.

◆ ClearFlags()

void TObj_Object::ClearFlags ( const Standard_Integer  theMask = ~0)

clears flags by the mask.

◆ Clone()

virtual Handle< TObj_Object > TObj_Object::Clone ( const TDF_Label theTargetLabel,
Handle< TDF_RelocationTable theRelocTable = 0 
)
virtual

Copy me to other label theTargetLabel New object will not have all the reference that has me. Coping object with data and childs, but change name by adding string "_copy" As result return handle of new object (null handle is something wrong) NOTE: BackReferences not coping. After clonning all objects it is neccessary to call copy references with the same relocation table.

Cloning related methods

◆ CopyChildren()

virtual void TObj_Object::CopyChildren ( TDF_Label theTargetLabel,
const Handle< TDF_RelocationTable > &  theRelocTable 
)
virtual

Coping the children from source label to the target.

◆ copyData()

virtual Standard_Boolean TObj_Object::copyData ( const Handle< TObj_Object > &  theTargetObject)
protectedvirtual

Coping the data of me to Target object. return Standard_False is Target object is different type.

Protected Methods copy data of object to other object

Reimplemented in TObj_Partition.

◆ CopyReferences()

virtual void TObj_Object::CopyReferences ( const Handle< TObj_Object > &  theTargetObject,
const Handle< TDF_RelocationTable > &  theRelocTable 
)
virtual

Coping the references. return Standard_False is Target object is different type.

◆ copyReferences()

void TObj_Object::copyReferences ( const TDF_Label theSourceLabel,
TDF_Label theTargetLabel,
const Handle< TDF_RelocationTable > &  theRelocTable 
)
protected

Coping the references from source label to the target.

◆ Detach() [1/2]

virtual Standard_Boolean TObj_Object::Detach ( const TObj_DeletingMode  theMode = TObj_FreeOnly)
virtual

Deletes the object from the model. The dependent objects are either deleted or modified when possible (see description of TObj_DeletingMode enumeration for more details) Returns True if deletion was successful. Checks if object can be deleted. Should be redefined for each specific kind of object.

◆ Detach() [2/2]

static Standard_Boolean TObj_Object::Detach ( const TDF_Label theLabel,
const TObj_DeletingMode  theMode = TObj_FreeOnly 
)
static

Deletes the object from the label. Checks if object can be deleted. Finds object on the label and detaches it by calling previos method. Returns true if there is no object on the label after detaching.

◆ getAsciiString()

Handle< TCollection_HAsciiString > TObj_Object::getAsciiString ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the string value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel).

◆ GetBackReferences()

virtual Handle< TObj_ObjectIterator > TObj_Object::GetBackReferences ( const Handle< Standard_Type > &  theType = NULL) const
virtual

Returns iterator for the objects which depend on this one. These reffering objects may belong to other models. theType narrows a variety of iterated objects.

◆ GetBadReference()

virtual Standard_Boolean TObj_Object::GetBadReference ( const TDF_Label theRoot,
TDF_Label theBadReference 
) const
virtual

Return True if this refers to the model theRoot belongs to and a referred label is not a descendant of theRoot. In this case theBadReference returns the currently referred label.

◆ GetChildLabel()

TDF_Label TObj_Object::GetChildLabel ( ) const

Returns the label under which children are stored.

◆ getChildLabel()

TDF_Label TObj_Object::getChildLabel ( const Standard_Integer  theRank) const

Returns the label for child with rank.

◆ GetChildren()

virtual Handle< TObj_ObjectIterator > TObj_Object::GetChildren ( const Handle< Standard_Type > &  theType = NULL) const
virtual

Returns iterator for the child objects. This method provides tree-like view of the objects hierarchy. The references to other objects are not considered as children. theType narrows a variety of iterated objects The default implementation search for children on 1 sublavel of the children sub label.

◆ GetDataLabel()

TDF_Label TObj_Object::GetDataLabel ( ) const

Returns the label which is the root for data OCAF sub-tree.

◆ getDataLabel()

TDF_Label TObj_Object::getDataLabel ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the theRank2-th sub label of the theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), sub label theRank1 of Data label is returned. If requested label does not exist, it is created.

Internal tools for work with OCAF data

◆ GetDictionary()

virtual Handle< TObj_TNameContainer > TObj_Object::GetDictionary ( ) const
virtual

Returns the map of names of the objects Default implementation returns global Dictionary of the model.

Methods hanling name of the object

◆ getExtString()

Handle< TCollection_HExtendedString > TObj_Object::getExtString ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the string value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel).

◆ getExtStringArray()

Handle< TColStd_HArray1OfExtendedString > TObj_Object::getExtStringArray ( const Standard_Integer  theLength,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns an existing or create a new string array on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). A newly created array has 1 and theLength bounds NOTE: new created array is NOT initialized.

NOTE: do not create new array and returns NULL handle if no array on label and theLength less than

WARNING: call setArray() after array contents modification in order to assure Undo work

◆ GetFatherObject()

Handle< TObj_Object > TObj_Object::GetFatherObject ( const Handle< Standard_Type > &  theType = NULL) const

Returns the father object, which may be NULL theType gives type of father object to search.

◆ GetFlags()

Standard_Integer TObj_Object::GetFlags ( ) const

Returns mask of seted flags.

◆ getInteger()

Standard_Integer TObj_Object::getInteger ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the integer value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns 0 if no integer value is stored on that label.

◆ getIntegerArray()

Handle< TColStd_HArray1OfInteger > TObj_Object::getIntegerArray ( const Standard_Integer  theLength,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0,
const Standard_Integer  theInitialValue = 0 
) const
protected

Returns an existing or create a new integer array on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). A newly created array has 1 and theLength bounds and is initialized with theInitialValue.

NOTE: do not create new array and returns NULL handle if no array on label and theLength less than

WARNING: call setArray() after array contents modification in order to assure Undo work

◆ GetLabel()

TDF_Label TObj_Object::GetLabel ( ) const

Returns the OCAF label on which object`s data are stored.

Access to the OCAF-specific data

◆ GetModel()

virtual Handle< TObj_Model > TObj_Object::GetModel ( ) const
virtual

Returns the model to which the object belongs.

Virtual methods

◆ GetName() [1/3]

virtual Handle< TCollection_HExtendedString > TObj_Object::GetName ( ) const
virtual

Returns the name of the object (empty string if object has no name)

◆ GetName() [2/3]

Standard_Boolean TObj_Object::GetName ( TCollection_ExtendedString theName) const

Returns the Standard_True is object has name and returns name to theName.

◆ GetName() [3/3]

Standard_Boolean TObj_Object::GetName ( TCollection_AsciiString theName) const

Returns the Standard_True is object has name and returns name to theName.

◆ GetNameForClone()

virtual Handle< TCollection_HExtendedString > TObj_Object::GetNameForClone ( const Handle< TObj_Object > &  ) const
inlinevirtual

Returns name for copy default implementation returns the same name.

◆ GetObj()

static Standard_Boolean TObj_Object::GetObj ( const TDF_Label theLabel,
Handle< TObj_Object > &  theResult,
const Standard_Boolean  isSuper = Standard_False 
)
static

Returns the Object attached to a given label. Returns False if no object of type TObj_Object is stored on the specified label. If isSuper is true tries to find on the super labels.

methods for object retrieval

◆ GetOrder()

virtual Standard_Integer TObj_Object::GetOrder ( ) const
virtual

returns order of object (or tag of their label if order is not initialised)

Public methods to access order of object

◆ getReal()

Standard_Real TObj_Object::getReal ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the real value from theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns 0.0 if no real value is stored on that label.

◆ getRealArray()

Handle< TColStd_HArray1OfReal > TObj_Object::getRealArray ( const Standard_Integer  theLength,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0,
const Standard_Real  theInitialValue = 0.0 
) const
protected

Returns an existing or create a new real array on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). A newly created array has 1 and theLength bounds and is initialized with theInitialValue.

NOTE: do not create new array and returns NULL handle if no array on label and theLength less than

WARNING: call setArray() after array contents modification in order to assure Undo work

◆ getReference()

Handle< TObj_Object > TObj_Object::getReference ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the reference attribute from theRank2-th sublabel of theRank1-th sublabel of the References label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel).

◆ GetReferenceLabel()

TDF_Label TObj_Object::GetReferenceLabel ( ) const

Returns the label which is the root for reference OCAF sub-tree.

◆ getReferenceLabel()

TDF_Label TObj_Object::getReferenceLabel ( const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns the theRank2-th sub label of the theRank1-th sublabel of the Reference label of the object. If theRank2 is 0 (default), sub label theRank1 of Reference label is returned. If requested label does not exist, it is created.

◆ GetReferences()

virtual Handle< TObj_ObjectIterator > TObj_Object::GetReferences ( const Handle< Standard_Type > &  theType = NULL) const
virtual

Returns an Iterator containing objects that compose the this one theType narrows a variety of iterated objects.

◆ GetTypeFlags()

virtual Standard_Integer TObj_Object::GetTypeFlags ( ) const
virtual

Returns flags (bitmask) that define properties of objects of that type By default returns flag Visible.

Access to object flags

Reimplemented in TObj_HiddenPartition.

◆ HasBackReferences()

Standard_Boolean TObj_Object::HasBackReferences ( ) const

Returns TRUE if obejct has 1 or more back references.

◆ HasReference()

virtual Standard_Boolean TObj_Object::HasReference ( const Handle< TObj_Object > &  theObject) const
virtual

Returns True if object has reference to indicated object.

Analysis of dependencies on other objects

◆ initFields()

void TObj_Object::initFields ( )
inlineprotected

This method is called from persistence to initialize the object fields, so successors that have transient fields must initialize them in initFields(), and call the same method of parent.

◆ IsAlive()

virtual Standard_Boolean TObj_Object::IsAlive ( ) const
virtual

Checks that object alive in model Default implementation checks that object has TObject attribute at own label.

Methods for checking and Updating object

◆ isDataAttribute()

Standard_Boolean TObj_Object::isDataAttribute ( const Standard_GUID theGUID,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Returns True if there is an attribute having theGUID on the theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed, not its sublabel.

◆ RelocateReferences()

virtual Standard_Boolean TObj_Object::RelocateReferences ( const TDF_Label theFromRoot,
const TDF_Label theToRoot,
const Standard_Boolean  theUpdateBackRefs = Standard_True 
)
virtual

Make that each reference pointing to a descendant label of theFromRoot to point to an equivalent label under theToRoot. Return False if a resulting reference does not point to an TObj_Object Example: a referred object label = 0:3:24:7:2:7 theFromRoot = 0:3:24 theToRoot = 0:2 a new referred label = 0:2:7:2:7.

◆ RemoveAllReferences()

virtual void TObj_Object::RemoveAllReferences ( )
virtual

Remove all references to other objects, by removing all reference attributes.

◆ RemoveBackReference()

virtual void TObj_Object::RemoveBackReference ( const Handle< TObj_Object > &  theObject,
const Standard_Boolean  theSingleOnly = Standard_True 
)
virtual

Removes information on dependent object (back reference). If theSingleOnly is true only the first back reference is removed in the case of duplicate items.

◆ RemoveBackReferences()

virtual Standard_Boolean TObj_Object::RemoveBackReferences ( const TObj_DeletingMode  theMode = TObj_FreeOnly)
virtual

Removes all back reference by removing references from other to me.

◆ RemoveReference()

virtual void TObj_Object::RemoveReference ( const Handle< TObj_Object > &  theObject)
virtual

Removes reference to the object by replace reference to NULL object.

◆ ReplaceReference()

virtual void TObj_Object::ReplaceReference ( const Handle< TObj_Object > &  theOldObject,
const Handle< TObj_Object > &  theNewObject 
)
virtual

Replace reference from old object to new object. If it is not possible, may raise exception. If new object is null then simple remove reference to old object.

◆ setArray() [1/3]

void TObj_Object::setArray ( const Handle< TColStd_HArray1OfReal > &  theArray,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
)
protected

Store theArray on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). If theArray is null then array attribute if any is removed.

◆ setArray() [2/3]

void TObj_Object::setArray ( const Handle< TColStd_HArray1OfInteger > &  theArray,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
)
protected

Store theArray on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). If theArray is null then array attribute if any is removed.

◆ setArray() [3/3]

void TObj_Object::setArray ( const Handle< TColStd_HArray1OfExtendedString > &  theArray,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
)
protected

Store theArray on theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). If theArray is null then array attribute if any is removed.

◆ setAsciiString()

void TObj_Object::setAsciiString ( const Handle< TCollection_HAsciiString > &  theValue,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Sets the ascii string value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel).

◆ setExtString()

void TObj_Object::setExtString ( const Handle< TCollection_HExtendedString > &  theValue,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Sets the string value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel).

◆ SetFlags()

void TObj_Object::SetFlags ( const Standard_Integer  theMask)

Sets flags with defined mask.

◆ setInteger()

Standard_Boolean TObj_Object::setInteger ( const Standard_Integer  theValue,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
) const
protected

Sets the integer value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns True if new value is actually different from previous one.

◆ SetName() [1/3]

virtual Standard_Boolean TObj_Object::SetName ( const Handle< TCollection_HExtendedString > &  theName) const
virtual

Sets name of the object. Returns False if theName is not unique.

Reimplemented in TObj_Partition.

◆ SetName() [2/3]

Standard_Boolean TObj_Object::SetName ( const Handle< TCollection_HAsciiString > &  theName) const

Sets name of the object. Returns False if theName is not unique.

◆ SetName() [3/3]

Standard_Boolean TObj_Object::SetName ( const Standard_CString  name) const

Sets name of the object. Returns False if theName is not unique.

◆ SetOrder()

virtual Standard_Boolean TObj_Object::SetOrder ( const Standard_Integer theIndx)
virtual

sets order of object

◆ setReal()

Standard_Boolean TObj_Object::setReal ( const Standard_Real  theValue,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0,
const Standard_Real  theTolerance = 0. 
) const
protected

Sets the real value for theRank2-th sublabel of theRank1-th sublabel of the Data label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns True if new value is actually different from previous one (with specified tolerance)

◆ setReference()

Standard_Boolean TObj_Object::setReference ( const Handle< TObj_Object > &  theObject,
const Standard_Integer  theRank1,
const Standard_Integer  theRank2 = 0 
)
protected

Sets the reference to theObject on theRank2-th sublabel of theRank1-th sublabel of the References label of the object. If theRank2 is 0 (default), label theRank1 is supposed (not its sublabel). Returns True if new value is actually different from previous one If Object is NULL, reference is deleted.

◆ TestFlags()

Standard_Boolean TObj_Object::TestFlags ( const Standard_Integer  theMask) const

tests flags by the mask.


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