Open CASCADE Technology 7.8.2.dev
DDF_Browser Class Reference

Browses a data framework from TDF. More...

#include <DDF_Browser.hxx>

Inheritance diagram for DDF_Browser:

Public Member Functions

 DDF_Browser (const Handle< TDF_Data > &aDF)
 
void DrawOn (Draw_Display &dis) const override
 
virtual Handle< Draw_Drawable3DCopy () const override
 For variable copy.
 
virtual void Dump (Standard_OStream &S) const override
 For variable dump.
 
virtual void Whatis (Draw_Interpretor &I) const override
 For variable whatis command. Set as a result the type of the variable.
 
void Data (const Handle< TDF_Data > &aDF)
 
Handle< TDF_DataData () const
 
TCollection_AsciiString OpenRoot () const
 Returns a string composed with the sub-label entries of <myDF>.
 
TCollection_AsciiString OpenLabel (const TDF_Label &aLab) const
 Returns a string composed with the sub-label entries of <aLab>.
 
TCollection_AsciiString OpenAttributeList (const TDF_Label &aLab)
 Returns a string composed with the attribute index (found in <myAttMap>) of <aLab>.
 
TCollection_AsciiString OpenAttribute (const Standard_Integer anIndex=0)
 Returns a string composed with the list of referenced attribute index of the attribute <anIndex>. For example, it is useful for TDataStd_Group. It uses a mechanism based on a DDF_AttributeBrowser.
 
TCollection_AsciiString Information () const
 Returns information about <me> to be displayed in information window.
 
TCollection_AsciiString Information (const TDF_Label &aLab) const
 Returns information about <aLab> to be displayed in information window.
 
TCollection_AsciiString Information (const Standard_Integer anIndex=0) const
 Returns information about attribute <anIndex> to be displayed in information window.
 
- Public Member Functions inherited from Draw_Drawable3D
virtual Standard_Boolean PickReject (const Standard_Real X, const Standard_Real Y, const Standard_Real Prec) const
 Returns True if the pick is outside the box.
 
virtual void Save (Standard_OStream &theStream) const
 Save drawable into stream; default implementation raises Standard_NotImplemented exception.
 
virtual bool Is3D () const
 Is a 3D object. (Default True).
 
virtual bool IsDisplayable () const
 Return TRUE if object can be displayed.
 
void SetBounds (const Standard_Real theXMin, const Standard_Real theXMax, const Standard_Real theYMin, const Standard_Real theYMax)
 
void Bounds (Standard_Real &theXMin, Standard_Real &theXMax, Standard_Real &theYMin, Standard_Real &theYMax) const
 
Standard_Boolean Visible () const
 
void Visible (const Standard_Boolean V)
 
Standard_Boolean Protected () const
 
void Protected (const Standard_Boolean P)
 
Standard_CString Name () const
 
virtual void Name (const Standard_CString N)
 
- 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.
 

Additional Inherited Members

- Public Types inherited from Draw_Drawable3D
typedef Handle< Draw_Drawable3D >(*) FactoryFunction_t(Standard_IStream &theStream)
 Function type for restoring drawable from stream.
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Draw_Drawable3D
static void RegisterFactory (const Standard_CString theType, const FactoryFunction_t &theFactory)
 Register factory for restoring drawable from stream (opposite to Draw_Drawable3D::Save()).
 
static Handle< Draw_Drawable3DRestore (const Standard_CString theType, Standard_IStream &theStream)
 Restore drawable from stream (opposite to Draw_Drawable3D::Save()).
 
- 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.
 
- Protected Member Functions inherited from Draw_Drawable3D
 Draw_Drawable3D ()
 

Detailed Description

Browses a data framework from TDF.

Constructor & Destructor Documentation

◆ DDF_Browser()

DDF_Browser::DDF_Browser ( const Handle< TDF_Data > & aDF)

Member Function Documentation

◆ Copy()

virtual Handle< Draw_Drawable3D > DDF_Browser::Copy ( ) const
overridevirtual

For variable copy.

Reimplemented from Draw_Drawable3D.

◆ Data() [1/2]

Handle< TDF_Data > DDF_Browser::Data ( ) const

◆ Data() [2/2]

void DDF_Browser::Data ( const Handle< TDF_Data > & aDF)

◆ DrawOn()

void DDF_Browser::DrawOn ( Draw_Display & dis) const
overridevirtual

Implements Draw_Drawable3D.

◆ Dump()

virtual void DDF_Browser::Dump ( Standard_OStream & S) const
overridevirtual

For variable dump.

Reimplemented from Draw_Drawable3D.

◆ Information() [1/3]

TCollection_AsciiString DDF_Browser::Information ( ) const

Returns information about <me> to be displayed in information window.

◆ Information() [2/3]

TCollection_AsciiString DDF_Browser::Information ( const Standard_Integer anIndex = 0) const

Returns information about attribute <anIndex> to be displayed in information window.

◆ Information() [3/3]

TCollection_AsciiString DDF_Browser::Information ( const TDF_Label & aLab) const

Returns information about <aLab> to be displayed in information window.

◆ OpenAttribute()

TCollection_AsciiString DDF_Browser::OpenAttribute ( const Standard_Integer anIndex = 0)

Returns a string composed with the list of referenced attribute index of the attribute <anIndex>. For example, it is useful for TDataStd_Group. It uses a mechanism based on a DDF_AttributeBrowser.

◆ OpenAttributeList()

TCollection_AsciiString DDF_Browser::OpenAttributeList ( const TDF_Label & aLab)

Returns a string composed with the attribute index (found in <myAttMap>) of <aLab>.

◆ OpenLabel()

TCollection_AsciiString DDF_Browser::OpenLabel ( const TDF_Label & aLab) const

Returns a string composed with the sub-label entries of <aLab>.

◆ OpenRoot()

TCollection_AsciiString DDF_Browser::OpenRoot ( ) const

Returns a string composed with the sub-label entries of <myDF>.

◆ Whatis()

virtual void DDF_Browser::Whatis ( Draw_Interpretor & I) const
overridevirtual

For variable whatis command. Set as a result the type of the variable.

Reimplemented from Draw_Drawable3D.


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