OCC Main Page | ApplicationFramework | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# ApplicationFramework
TKTObj
TObj

# TObj_Object Class Reference

Basis class for transient objects in OCAF-based models.

`#include <TObj_Object.hxx>`

Inheritance diagram for TObj_Object:

[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 Member Functions
virtual Standard_EXPORT | Handle (TObj_Model) GetModel() const
| Returns the model to which the object belongs.
virtual Standard_EXPORT | Handle (TObj_ObjectIterator) GetChildren(const Handle(Standard_Type)&theType
| 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.
Standard_EXPORT TDF_Label | GetChildLabel () const
| Returns the label under which children are stored.
Standard_EXPORT TDF_Label | getChildLabel (const Standard_Integer theRank) const
| Returns the label for child with rank.
Standard_EXPORT TDF_Label | GetLabel () const
| Returns the OCAF label on which object`s data are stored.
Standard_EXPORT TDF_Label | GetDataLabel () const
| Returns the label which is the root for data OCAF sub-tree.
Standard_EXPORT TDF_Label | GetReferenceLabel () const
| Returns the label which is the root for reference OCAF sub-tree.
virtual Standard_EXPORT | Handle (TObj_TNameContainer) GetDictionary() const
| Returns the map of names of the objects Default implementation returns global Dictionary of the model.
virtual Standard_EXPORT | Handle (TCollection_HExtendedString) GetName() const
| Returns the name of the object (empty string if object has no name).
Standard_EXPORT Standard_Boolean | GetName (TCollection_ExtendedString &theName) const
| Returns the Standard_True is object has name and returns name to theName.
Standard_EXPORT Standard_Boolean | GetName (TCollection_AsciiString &theName) const
| Returns the Standard_True is object has name and returns name to theName.
virtual Standard_EXPORT Standard_Boolean | SetName (const Handle(TCollection_HExtendedString)&theName) const
| Sets name of the object. Returns False if theName is not unique.
Standard_EXPORT Standard_Boolean | SetName (const Handle(TCollection_HAsciiString)&theName) const
| Sets name of the object. Returns False if theName is not unique.
Standard_EXPORT Standard_Boolean | SetName (const Standard_CString name) const
| Sets name of the object. Returns False if theName is not unique.
virtual Standard_EXPORT | Handle (TCollection_HExtendedString) GetNameForClone(const Handle(TObj_Object)&) const
| Returns name for copy default implementation returns the same name.
virtual Standard_EXPORT Standard_Boolean | HasReference (const Handle(TObj_Object)&theObject) const
| Returns True if object has reference to indicated object.
virtual Standard_EXPORT | Handle (TObj_ObjectIterator) GetReferences(const Handle(Standard_Type)&theType
| Returns an Iterator containing objects that compose the this one theType narrows a variety of iterated objects.
virtual Standard_EXPORT void | RemoveAllReferences ()
| Remove all references to other objects, by removing all reference attributes.
virtual Standard_EXPORT | Handle (TObj_ObjectIterator) GetBackReferences(const Handle(Standard_Type)&theType
| 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.
virtual Standard_EXPORT 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).
virtual Standard_EXPORT 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.
virtual Standard_EXPORT Standard_Boolean | RemoveBackReferences (const TObj_DeletingMode theMode=TObj_FreeOnly)
| Removes all back reference by removing references from other to me.
virtual Standard_EXPORT void | ClearBackReferences ()
| The default implementation just clear the back references container.
Standard_EXPORT Standard_Boolean | HasBackReferences () const
| Returns TRUE if obejct has 1 or more back references.
virtual Standard_EXPORT 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.
virtual Standard_EXPORT 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.
virtual Standard_EXPORT 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.
virtual Standard_EXPORT 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.
virtual Standard_EXPORT void | RemoveReference (const Handle(TObj_Object)&theObject)
| Removes reference to the object by replace reference to NULL object.
virtual Standard_EXPORT void | BeforeForgetReference (const TDF_Label &)
| Invokes from TObj_TReference::BeforeForget(). theLabel - label on that reference become removed Default implementation is empty.
virtual Standard_EXPORT Standard_Boolean | CanDetach (const TObj_DeletingMode theMode=TObj_FreeOnly)
| Checks if object can be detached with specified mode.
virtual Standard_EXPORT 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.
Standard_EXPORT | Handle (TObj_Object) GetFatherObject(const Handle(Standard_Type)&theType
| Returns the father object, which may be NULL theType gives type of father object to search.
virtual Standard_EXPORT Standard_Boolean | IsAlive () const
| Checks that object alive in model Default implementation checks that object has TObject attribute at own label.
virtual Standard_EXPORT | Handle (TObj_Object) Clone(const TDF_Label &theTargetLabel
| 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.
virtual Standard_EXPORT | Handle (TDF_RelocationTable) theRelocTable=0)
virtual Standard_EXPORT void | CopyReferences (const Handle(TObj_Object)&theTargetObject, const Handle(TDF_RelocationTable)&theRelocTable)
| Coping the references. return Standard_False is Target object is different type.
virtual Standard_EXPORT void | CopyChildren (TDF_Label &theTargetLabel, const Handle(TDF_RelocationTable)&theRelocTable)
| Coping the children from source label to the target.
virtual Standard_EXPORT Standard_Integer | GetOrder () const
| returns order of object (or tag of their label if order is not initialised)
virtual Standard_EXPORT Standard_Boolean | SetOrder (const Standard_Integer &theIndx)
| sets order of object
virtual Standard_EXPORT Standard_Integer | GetTypeFlags () const
| Returns flags (bitmask) that define properties of objects of that type By default returns flag Visible.
Standard_EXPORT Standard_Integer | GetFlags () const
| Returns mask of seted flags.
Standard_EXPORT void | SetFlags (const Standard_Integer theMask)
| Sets flags with defined mask.
Standard_EXPORT Standard_Boolean | TestFlags (const Standard_Integer theMask) const
| tests flags by the mask.
Standard_EXPORT void | ClearFlags (const Standard_Integer theMask=~0)
| clears flags by the mask.
virtual Standard_EXPORT void | AfterRetrieval ()
| Preforms updating the links and dependances of the object which are not stored in persistence. Should be redefined if necessary.
virtual Standard_EXPORT void | BeforeStoring ()
| Preforms storing the objects transient fields in OCAF document which were outside transaction mechanism. Default implementation doesnot nothing.
## Static Public Member Functions
static Standard_EXPORT 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.
static Standard_EXPORT 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.
## 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
Standard_EXPORT | 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.
Standard_EXPORT | 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.
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.
virtual Standard_EXPORT 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.
Standard_EXPORT void | copyReferences (const TDF_Label &theSourceLabel, TDF_Label &theTargetLabel, const Handle(TDF_RelocationTable)&theRelocTable)
| Coping the references from source label to the target.
Standard_EXPORT 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.
Standard_EXPORT 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.
Standard_EXPORT 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.
Standard_EXPORT 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.
Standard_EXPORT 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).
Standard_EXPORT 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.
Standard_EXPORT 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.
Standard_EXPORT | Handle (TColStd_HArray1OfReal) getRealArray(const Standard_Integer theLength
| 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.
Standard_EXPORT | Handle (TColStd_HArray1OfInteger) getIntegerArray(const Standard_Integer theLength
| 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.
Standard_EXPORT | Handle (TColStd_HArray1OfExtendedString) getExtStringArray(const Standard_Integer theLength
| 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.
Standard_EXPORT 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.
Standard_EXPORT 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.
Standard_EXPORT 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.
Standard_EXPORT 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).
Standard_EXPORT | Handle (TCollection_HExtendedString) getExtString(const Standard_Integer theRank1
| 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).
Standard_EXPORT 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).
Standard_EXPORT | Handle (TCollection_HAsciiString) getAsciiString(const Standard_Integer theRank1
| 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).
Standard_EXPORT | Handle (TObj_Object) getReference(const Standard_Integer theRank1
| 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).
Standard_EXPORT 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.
Standard_EXPORT 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.
## Protected Attributes
Standard_EXPORT const Standard_Integer | theRank1
Standard_EXPORT const Standard_Integer const Standard_Integer | theRank2 = 0
Standard_EXPORT const Standard_Integer const Standard_Integer const Standard_Real | theInitialValue = 0.0) const
Standard_EXPORT const Standard_Integer const Standard_Integer const Standard_Integer | theInitialValue = 0) const
Standard_EXPORT const Standard_Integer | theRank2 = 0) const
## Private Member Functions
| Handle (TObj_HSequenceOfObject) myHSeqBackRef
| hsequence of back references.
## Private Attributes
TDF_Label | myLabel
| Label on which object`s data are stored.

## Member Enumeration Documentation

enum TObj_Object::ChildTag`[protected]`

  | Enumeration values:
  ChildTag_First |
  ChildTag_Last | No children.

enum TObj_Object::DataTag`[protected]`

  | Enumeration values:
  DataTag_First |
  DataTag_Flags | stores flags of object
  DataTag_Order | stores order of object
  DataTag_Last | Reserved for possible future use.
Reimplemented in TObj_Partition.

enum TObj_Object::ObjectState

  | Enumeration values:
  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

enum TObj_Object::RefTag`[protected]`

  | Enumeration values:
  RefTag_First |
  RefTag_Last | No children.

enum TObj_Object::TypeFlags

  | Enumeration values:
  Visible | Is visible in DataViewer.

## Constructor & Destructor Documentation

Standard_EXPORT TObj_Object::TObj_Object | ( | const TDF_Label & | theLabel,
|  | const Standard_Boolean | theSetName = `Standard_True`
| ) | `[protected]`

| Constructors

Standard_EXPORT TObj_Object::TObj_Object | ( | const TObj_Persistence * | ,
|  | const TDF_Label & | theLabel
| ) | `[inline, protected]`

## Member Function Documentation

virtual Standard_EXPORT void TObj_Object::AddBackReference | ( | const Handle(TObj_Object)& | theObject | ) | `[virtual]`

Standard_EXPORT TDF_Label TObj_Object::addReference | ( | const Standard_Integer | theRank1,
|  | const Handle(TObj_Object)& | theObject
| ) | `[protected]`

virtual Standard_EXPORT void TObj_Object::AfterRetrieval | ( |  | ) | `[virtual]`

| Method for updating object afrer restoring Reimplemented in TObj_Partition.

virtual Standard_EXPORT void TObj_Object::BeforeForgetReference | ( | const TDF_Label & |  | ) | `[inline, virtual]`

virtual Standard_EXPORT void TObj_Object::BeforeStoring | ( |  | ) | `[virtual]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::CanDetach | ( | const TObj_DeletingMode | theMode = `TObj_FreeOnly` | ) | `[virtual]`

| Methods for deleting the object

virtual Standard_EXPORT Standard_Boolean TObj_Object::CanRemoveReference | ( | const Handle(TObj_Object)& | theObject | ) | const`[virtual]`

virtual Standard_EXPORT void TObj_Object::ClearBackReferences | ( |  | ) | `[virtual]`

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

virtual Standard_EXPORT void TObj_Object::CopyChildren | ( | TDF_Label & | theTargetLabel,
|  | const Handle(TDF_RelocationTable)& | theRelocTable
| ) | `[virtual]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::copyData | ( | const Handle(TObj_Object)& | theTargetObject | ) | `[protected, virtual]`

| Protected Methods copy data of object to other object Reimplemented in TObj_Partition.

Standard_EXPORT void TObj_Object::copyReferences | ( | const TDF_Label & | theSourceLabel,
|  | TDF_Label & | theTargetLabel,
|  | const Handle(TDF_RelocationTable)& | theRelocTable
| ) | `[protected]`

virtual Standard_EXPORT void TObj_Object::CopyReferences | ( | const Handle(TObj_Object)& | theTargetObject,
|  | const Handle(TDF_RelocationTable)& | theRelocTable
| ) | `[virtual]`

static Standard_EXPORT Standard_Boolean TObj_Object::Detach | ( | const TDF_Label & | theLabel,
|  | const TObj_DeletingMode | theMode = `TObj_FreeOnly`
| ) | `[static]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::Detach | ( | const TObj_DeletingMode | theMode = `TObj_FreeOnly` | ) | `[virtual]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::GetBadReference | ( | const TDF_Label & | theRoot,
|  | TDF_Label & | theBadReference
| ) | const`[virtual]`

Standard_EXPORT TDF_Label TObj_Object::getChildLabel | ( | const Standard_Integer | theRank | ) | const

Standard_EXPORT TDF_Label TObj_Object::GetChildLabel | ( |  | ) | const

Standard_EXPORT TDF_Label TObj_Object::getDataLabel | ( | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

| Internal tools for work with OCAF data

Standard_EXPORT TDF_Label TObj_Object::GetDataLabel | ( |  | ) | const

Standard_EXPORT Standard_Integer TObj_Object::GetFlags | ( |  | ) | const

Standard_EXPORT Standard_Integer TObj_Object::getInteger | ( | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

Standard_EXPORT TDF_Label TObj_Object::GetLabel | ( |  | ) | const

| Access to the OCAF-specific data

Standard_EXPORT Standard_Boolean TObj_Object::GetName | ( | TCollection_AsciiString & | theName | ) | const

Standard_EXPORT Standard_Boolean TObj_Object::GetName | ( | TCollection_ExtendedString & | theName | ) | const

static Standard_EXPORT Standard_Boolean TObj_Object::GetObj | ( | const TDF_Label & | theLabel,
|  | Handle(TObj_Object)& | theResult,
|  | const Standard_Boolean | isSuper = `Standard_False`
| ) | `[static]`

| methods for object retrieval

virtual Standard_EXPORT Standard_Integer TObj_Object::GetOrder | ( |  | ) | const`[virtual]`

| Public methods to access order of object

Standard_EXPORT Standard_Real TObj_Object::getReal | ( | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

Standard_EXPORT TDF_Label TObj_Object::getReferenceLabel | ( | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

Standard_EXPORT TDF_Label TObj_Object::GetReferenceLabel | ( |  | ) | const

virtual Standard_EXPORT Standard_Integer TObj_Object::GetTypeFlags | ( |  | ) | const`[virtual]`

| Access to object flags Reimplemented in TObj_HiddenPartition.

TObj_Object::Handle | ( | TObj_HSequenceOfObject |  | ) | `[private]`

Standard_EXPORT TObj_Object::Handle | ( | TObj_Object |  | ) | const`[protected]`

Standard_EXPORT TObj_Object::Handle | ( | TCollection_HAsciiString |  | ) | const`[protected]`

Standard_EXPORT TObj_Object::Handle | ( | TCollection_HExtendedString |  | ) | const`[protected]`

| Reimplemented in TObj_Partition, and TObj_Partition.

Standard_EXPORT TObj_Object::Handle | ( | TColStd_HArray1OfExtendedString |  | ) | const`[protected]`

Standard_EXPORT TObj_Object::Handle | ( | TColStd_HArray1OfInteger |  | ) | const`[protected]`

Standard_EXPORT TObj_Object::Handle | ( | TColStd_HArray1OfReal |  | ) | const`[protected]`

virtual Standard_EXPORT TObj_Object::Handle | ( | TDF_RelocationTable |  | ) | `[pure virtual]`

virtual Standard_EXPORT TObj_Object::Handle | ( | TObj_Object |  | ) | const`[virtual]`

| Cloning related methods

Standard_EXPORT TObj_Object::Handle | ( | TObj_Object |  | ) | const

virtual Standard_EXPORT TObj_Object::Handle | ( | TObj_ObjectIterator |  | ) | const`[virtual]`

virtual Standard_EXPORT TObj_Object::Handle | ( | TObj_ObjectIterator |  | ) | const`[virtual]`

virtual Standard_EXPORT TObj_Object::Handle | ( | TCollection_HExtendedString |  | ) | const`[inline, virtual]`

| Reimplemented in TObj_Partition, and TObj_Partition.

virtual Standard_EXPORT TObj_Object::Handle | ( | TCollection_HExtendedString |  | ) | const`[virtual]`

| Reimplemented in TObj_Partition, and TObj_Partition.

virtual Standard_EXPORT TObj_Object::Handle | ( | TObj_TNameContainer |  | ) | const`[virtual]`

| Methods hanling name of the object

virtual Standard_EXPORT TObj_Object::Handle | ( | TObj_ObjectIterator |  | ) | const`[virtual]`

virtual Standard_EXPORT TObj_Object::Handle | ( | TObj_Model |  | ) | const`[virtual]`

| Virtual methods

Standard_EXPORT Standard_Boolean TObj_Object::HasBackReferences | ( |  | ) | const

virtual Standard_EXPORT Standard_Boolean TObj_Object::HasReference | ( | const Handle(TObj_Object)& | theObject | ) | const`[virtual]`

| Analysis of dependencies on other objects

void TObj_Object::initFields | ( |  | ) | `[inline, protected]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::IsAlive | ( |  | ) | const`[virtual]`

| Methods for checking and Updating object

Standard_EXPORT Standard_Boolean TObj_Object::isDataAttribute | ( | const Standard_GUID & | theGUID,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::RelocateReferences | ( | const TDF_Label & | theFromRoot,
|  | const TDF_Label & | theToRoot,
|  | const Standard_Boolean | theUpdateBackRefs = `Standard_True`
| ) | `[virtual]`

virtual Standard_EXPORT void TObj_Object::RemoveAllReferences | ( |  | ) | `[virtual]`

virtual Standard_EXPORT void TObj_Object::RemoveBackReference | ( | const Handle(TObj_Object)& | theObject,
|  | const Standard_Boolean | theSingleOnly = `Standard_True`
| ) | `[virtual]`

virtual Standard_EXPORT Standard_Boolean TObj_Object::RemoveBackReferences | ( | const TObj_DeletingMode | theMode = `TObj_FreeOnly` | ) | `[virtual]`

virtual Standard_EXPORT void TObj_Object::RemoveReference | ( | const Handle(TObj_Object)& | theObject | ) | `[virtual]`

virtual Standard_EXPORT void TObj_Object::ReplaceReference | ( | const Handle(TObj_Object)& | theOldObject,
|  | const Handle(TObj_Object)& | theNewObject
| ) | `[virtual]`

Standard_EXPORT void TObj_Object::setArray | ( | const Handle(TColStd_HArray1OfExtendedString)& | theArray,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | `[protected]`

Standard_EXPORT void TObj_Object::setArray | ( | const Handle(TColStd_HArray1OfInteger)& | theArray,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | `[protected]`

Standard_EXPORT void TObj_Object::setArray | ( | const Handle(TColStd_HArray1OfReal)& | theArray,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | `[protected]`

Standard_EXPORT void TObj_Object::setAsciiString | ( | const Handle(TCollection_HAsciiString)& | theValue,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

Standard_EXPORT void TObj_Object::setExtString | ( | const Handle(TCollection_HExtendedString)& | theValue,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

Standard_EXPORT void TObj_Object::SetFlags | ( | const Standard_Integer | theMask | ) |

Standard_EXPORT Standard_Boolean TObj_Object::setInteger | ( | const Standard_Integer | theValue,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | const`[protected]`

Standard_EXPORT Standard_Boolean TObj_Object::SetName | ( | const Standard_CString | name | ) | const

Standard_EXPORT Standard_Boolean TObj_Object::SetName | ( | const Handle(TCollection_HAsciiString)& | theName | ) | const

virtual Standard_EXPORT Standard_Boolean TObj_Object::SetName | ( | const Handle(TCollection_HExtendedString)& | theName | ) | const`[virtual]`

| Reimplemented in TObj_Partition.

virtual Standard_EXPORT Standard_Boolean TObj_Object::SetOrder | ( | const Standard_Integer & | theIndx | ) | `[virtual]`

Standard_EXPORT 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]`

Standard_EXPORT Standard_Boolean TObj_Object::setReference | ( | const Handle(TObj_Object)& | theObject,
|  | const Standard_Integer | theRank1,
|  | const Standard_Integer | theRank2 = `0`
| ) | `[protected]`

Standard_EXPORT Standard_Boolean TObj_Object::TestFlags | ( | const Standard_Integer | theMask | ) | const

## Field Documentation

TDF_Label TObj_Object::myLabel`[private]`

| Fields

Standard_EXPORT const Standard_Integer const Standard_Integer const Standard_Integer TObj_Object::theInitialValue = 0) const`[protected]`

Standard_EXPORT const Standard_Integer const Standard_Integer const Standard_Real TObj_Object::theInitialValue = 0.0) const`[protected]`

Standard_EXPORT const Standard_Integer TObj_Object::theRank1`[protected]`

Standard_EXPORT const Standard_Integer TObj_Object::theRank2 = 0) const`[protected]`

Standard_EXPORT const Standard_Integer TObj_Object::theRank2 = 0`[protected]`

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

- TObj_Object.hxx