Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
StepData_DefaultGeneral Class Reference

DefaultGeneral defines a GeneralModule which processes Unknown Entity from StepData only. More...

#include <StepData_DefaultGeneral.hxx>

Inheritance diagram for StepData_DefaultGeneral:
Inheritance graph
[legend]

Public Member Functions

 StepData_DefaultGeneral ()
 Creates a Default General Module.
 
void FillSharedCase (const int casenum, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const override
 Specific filling of the list of Entities shared by an Entity <ent>, which is an UnknownEntity from StepData.
 
void CheckCase (const int casenum, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares, occ::handle< Interface_Check > &ach) const override
 Specific Checking of an Entity <ent>
 
bool NewVoid (const int CN, occ::handle< Standard_Transient > &entto) const override
 Specific creation of a new void entity.
 
void CopyCase (const int casenum, const occ::handle< Standard_Transient > &entfrom, const occ::handle< Standard_Transient > &entto, Interface_CopyTool &TC) const override
 Specific Copy ("Deep") from <entfrom> to <entto> (same type) by using a CopyTool which provides its working Map. Use method Transferred from TransferControl to work.
 
- Public Member Functions inherited from Interface_GeneralModule
virtual void FillShared (const occ::handle< Interface_InterfaceModel > &model, const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const
 Specific filling of the list of Entities shared by an Entity <ent>, according a Case Number <CN> (formerly computed by CaseNum), considered in the context of a Model <model> Default calls FillSharedCase (i.e., ignores the model) Can be redefined to use the model for working.
 
void Share (Interface_EntityIterator &iter, const occ::handle< Standard_Transient > &shared) const
 Adds an Entity to a Shared List (uses GetOneItem on <iter>)
 
virtual void ListImplied (const occ::handle< Interface_InterfaceModel > &model, const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const
 List the Implied References of <ent> considered in the context of a Model <model> : i.e. the Entities which are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillShared + ListImplied give the complete list of References Default calls ListImpliedCase (i.e. ignores the model) Can be redefined to use the model for working.
 
virtual void ListImpliedCase (const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const
 List the Implied References of <ent> (see above) are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillSharedCase + ListImpliedCase give the complete list of Referenced Entities The provided default method does nothing (Implied References are specific of a little amount of Entity Classes).
 
virtual bool CanCopy (const int CN, const occ::handle< Standard_Transient > &ent) const
 Specific answer to the question "is Copy properly implemented" Remark that it should be in phase with the implementation of NewVoid+CopyCase/NewCopyCase Default returns always False, can be redefined.
 
virtual bool Dispatch (const int CN, const occ::handle< Standard_Transient > &entfrom, occ::handle< Standard_Transient > &entto, Interface_CopyTool &TC) const
 Dispatches an entity Returns True if it works by copy, False if it just duplicates the starting Handle.
 
virtual bool NewCopiedCase (const int CN, const occ::handle< Standard_Transient > &entfrom, occ::handle< Standard_Transient > &entto, Interface_CopyTool &TC) const
 Specific operator (create+copy) defaulted to do nothing. It can be redefined : When it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructor : hence the result <entto> must be created with an effective definition. Remark : if NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else.
 
virtual void RenewImpliedCase (const int CN, const occ::handle< Standard_Transient > &entfrom, const occ::handle< Standard_Transient > &entto, const Interface_CopyTool &TC) const
 Specific Copying of Implied References A Default is provided which does nothing (must current case !) Already copied references (by CopyFrom) must remain unchanged Use method Search from CopyTool to work.
 
virtual void WhenDeleteCase (const int CN, const occ::handle< Standard_Transient > &ent, const bool dispatched) const
 Prepares an entity to be deleted. What does it mean : Basically, any class of entity may define its own destructor By default, it does nothing but calling destructors on fields With the Memory Manager, it is useless to call destructor, it is done automatically when the Handle is nullified(cleared) BUT this is ineffective in looping structures (whatever these are "Implied" references or not).
 
virtual int CategoryNumber (const int CN, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares) const
 Returns a category number which characterizes an entity Category Numbers are managed by the class Category <shares> can be used to evaluate this number in the context Default returns 0 which means "unspecified".
 
virtual occ::handle< TCollection_HAsciiStringName (const int CN, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares) const
 Determines if an entity brings a Name (or widerly, if a Name can be attached to it, through the ShareTool By default, returns a Null Handle (no name can be produced) Can be redefined.
 
- 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 ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 

Detailed Description

DefaultGeneral defines a GeneralModule which processes Unknown Entity from StepData only.

Constructor & Destructor Documentation

◆ StepData_DefaultGeneral()

StepData_DefaultGeneral::StepData_DefaultGeneral ( )

Creates a Default General Module.

Member Function Documentation

◆ CheckCase()

void StepData_DefaultGeneral::CheckCase ( const int casenum,
const occ::handle< Standard_Transient > & ent,
const Interface_ShareTool & shares,
occ::handle< Interface_Check > & ach ) const
overridevirtual

Specific Checking of an Entity <ent>

Implements StepData_GeneralModule.

◆ CopyCase()

void StepData_DefaultGeneral::CopyCase ( const int casenum,
const occ::handle< Standard_Transient > & entfrom,
const occ::handle< Standard_Transient > & entto,
Interface_CopyTool & TC ) const
overridevirtual

Specific Copy ("Deep") from <entfrom> to <entto> (same type) by using a CopyTool which provides its working Map. Use method Transferred from TransferControl to work.

Implements StepData_GeneralModule.

◆ FillSharedCase()

void StepData_DefaultGeneral::FillSharedCase ( const int casenum,
const occ::handle< Standard_Transient > & ent,
Interface_EntityIterator & iter ) const
overridevirtual

Specific filling of the list of Entities shared by an Entity <ent>, which is an UnknownEntity from StepData.

Implements StepData_GeneralModule.

◆ NewVoid()

bool StepData_DefaultGeneral::NewVoid ( const int CN,
occ::handle< Standard_Transient > & entto ) const
overridevirtual

Specific creation of a new void entity.

Implements Interface_GeneralModule.


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