Open CASCADE Technology  7.3.0
Public Member Functions

Interface_ReportEntity Class Reference

A ReportEntity is produced to aknowledge and memorize the binding between a Check and an Entity. The Check can bring Fails (+ Warnings if any), or only Warnings. If it is empty, the Report Entity is for an Unknown Entity. More...

#include <Interface_ReportEntity.hxx>

Inheritance diagram for Interface_ReportEntity:
Inheritance graph
[legend]

Public Member Functions

 Interface_ReportEntity (const Handle< Standard_Transient > &unknown)
 Creates a ReportEntity for an Unknown Entity : Check is empty, and Concerned equates Content (i.e. the Unknown Entity) More...
 
 Interface_ReportEntity (const Handle< Interface_Check > &acheck, const Handle< Standard_Transient > &concerned)
 Creates a ReportEntity with its features : More...
 
void SetContent (const Handle< Standard_Transient > &content)
 Sets a Content : it brings non interpreted data which belong to the Concerned Entity. It can be empty then loaded later. Remark that for an Unknown Entity, Content is set by Create. More...
 
const Handle< Interface_Check > & Check () const
 Returns the stored Check. More...
 
Handle< Interface_Check > & CCheck ()
 Returns the stored Check in order to change it. More...
 
Handle< Standard_TransientConcerned () const
 Returns the stored Concerned Entity. It equates the Content in the case of an Unknown Entity. More...
 
Standard_Boolean HasContent () const
 Returns True if a Content is stored (it can equate Concerned) More...
 
Standard_Boolean HasNewContent () const
 Returns True if a Content is stored AND differs from Concerned (i.e. redefines content) : used when Concerned could not be loaded. More...
 
Handle< Standard_TransientContent () const
 Returns the stored Content, or a Null Handle Remark that it must be an "Unknown Entity" suitable for the norm of the containing Model. More...
 
Standard_Boolean IsError () const
 Returns True for an Error Entity, i.e. if the Check brings at least one Fail message. More...
 
Standard_Boolean IsUnknown () const
 Returns True for an Unknown Entity, i,e. if the Check is empty and Concerned equates Content. 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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...
 

Detailed Description

A ReportEntity is produced to aknowledge and memorize the binding between a Check and an Entity. The Check can bring Fails (+ Warnings if any), or only Warnings. If it is empty, the Report Entity is for an Unknown Entity.

The ReportEntity brings : the Concerned Entity, the Check, and if the Entity is empty (Fails due to Read Errors, hence the Entity could not be loaded), a Content. The Content is itself an Transient Object, but remains in a literal form : it is an "Unknown Entity". If the Concerned Entity is itself Unknown, Concerned and Content are equal.

According to the Check, if it brings Fail messages, the ReportEntity is an "Error Entity", the Concerned Entity is an "Erroneous Entity". Else it is a "Correction Entity", the Concerned Entity is a "Corrected Entity". With no Check message and if Concerened and Content are equal, it reports for an "Unknown Entity".

Each norm must produce its own type of Unknown Entity, but can use the class UndefinedContent to brings parameters : it is enough for most of information and avoids to redefine them, only the specific part remains to be defined for each norm.

Constructor & Destructor Documentation

◆ Interface_ReportEntity() [1/2]

Interface_ReportEntity::Interface_ReportEntity ( const Handle< Standard_Transient > &  unknown)

Creates a ReportEntity for an Unknown Entity : Check is empty, and Concerned equates Content (i.e. the Unknown Entity)

◆ Interface_ReportEntity() [2/2]

Interface_ReportEntity::Interface_ReportEntity ( const Handle< Interface_Check > &  acheck,
const Handle< Standard_Transient > &  concerned 
)

Creates a ReportEntity with its features :

  • <acheck> is the Check to be memorised
  • <concerned> is the Entity to which the Check is bound Later, a Content can be set : it is required for an Error

Member Function Documentation

◆ CCheck()

Handle< Interface_Check >& Interface_ReportEntity::CCheck ( )

Returns the stored Check in order to change it.

◆ Check()

const Handle< Interface_Check >& Interface_ReportEntity::Check ( ) const

Returns the stored Check.

◆ Concerned()

Handle< Standard_Transient > Interface_ReportEntity::Concerned ( ) const

Returns the stored Concerned Entity. It equates the Content in the case of an Unknown Entity.

◆ Content()

Handle< Standard_Transient > Interface_ReportEntity::Content ( ) const

Returns the stored Content, or a Null Handle Remark that it must be an "Unknown Entity" suitable for the norm of the containing Model.

◆ HasContent()

Standard_Boolean Interface_ReportEntity::HasContent ( ) const

Returns True if a Content is stored (it can equate Concerned)

◆ HasNewContent()

Standard_Boolean Interface_ReportEntity::HasNewContent ( ) const

Returns True if a Content is stored AND differs from Concerned (i.e. redefines content) : used when Concerned could not be loaded.

◆ IsError()

Standard_Boolean Interface_ReportEntity::IsError ( ) const

Returns True for an Error Entity, i.e. if the Check brings at least one Fail message.

◆ IsUnknown()

Standard_Boolean Interface_ReportEntity::IsUnknown ( ) const

Returns True for an Unknown Entity, i,e. if the Check is empty and Concerned equates Content.

◆ SetContent()

void Interface_ReportEntity::SetContent ( const Handle< Standard_Transient > &  content)

Sets a Content : it brings non interpreted data which belong to the Concerned Entity. It can be empty then loaded later. Remark that for an Unknown Entity, Content is set by Create.


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