Open CASCADE Technology  7.4.0.beta
Public Member Functions
StepData_GeneralModule Class Referenceabstract

Specific features for General Services adapted to STEP. More...

#include <StepData_GeneralModule.hxx>

Inheritance diagram for StepData_GeneralModule:
Inheritance graph
[legend]

Public Member Functions

virtual void FillSharedCase (const Standard_Integer casenum, const Handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const override=0
 Specific filling of the list of Entities shared by an Entity <ent>. Can use the internal utility method Share, below. More...
 
virtual void CheckCase (const Standard_Integer casenum, const Handle< Standard_Transient > &ent, const Interface_ShareTool &shares, Handle< Interface_Check > &ach) const override=0
 Specific Checking of an Entity <ent> More...
 
virtual void CopyCase (const Standard_Integer casenum, const Handle< Standard_Transient > &entfrom, const Handle< Standard_Transient > &entto, Interface_CopyTool &TC) const override=0
 Specific Copy ("Deep") from <entfrom> to <entto> (same type) by using a TransferControl which provides its working Map. Use method Transferred from TransferControl to work 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 TransferControl to work. More...
 
- Public Member Functions inherited from Interface_GeneralModule
virtual void FillShared (const Handle< Interface_InterfaceModel > &model, const Standard_Integer CN, const 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. More...
 
void Share (Interface_EntityIterator &iter, const Handle< Standard_Transient > &shared) const
 Adds an Entity to a Shared List (uses GetOneItem on <iter>) More...
 
virtual void ListImplied (const Handle< Interface_InterfaceModel > &model, const Standard_Integer CN, const 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. More...
 
virtual void ListImpliedCase (const Standard_Integer CN, const 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). More...
 
virtual Standard_Boolean CanCopy (const Standard_Integer CN, const 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. More...
 
virtual Standard_Boolean Dispatch (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, 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. More...
 
virtual Standard_Boolean NewVoid (const Standard_Integer CN, Handle< Standard_Transient > &entto) const =0
 Creates a new void entity <entto> according to a Case Number This entity remains to be filled, by reading from a file or by copying from another entity of same type (see CopyCase) More...
 
virtual Standard_Boolean NewCopiedCase (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, 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. More...
 
virtual void RenewImpliedCase (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, const 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. More...
 
virtual void WhenDeleteCase (const Standard_Integer CN, const Handle< Standard_Transient > &ent, const Standard_Boolean 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). More...
 
virtual Standard_Integer CategoryNumber (const Standard_Integer CN, const 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". More...
 
virtual Handle< TCollection_HAsciiStringName (const Standard_Integer CN, const 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. 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

Specific features for General Services adapted to STEP.

Member Function Documentation

◆ CheckCase()

virtual void StepData_GeneralModule::CheckCase ( const Standard_Integer  casenum,
const Handle< Standard_Transient > &  ent,
const Interface_ShareTool shares,
Handle< Interface_Check > &  ach 
) const
overridepure virtual

Specific Checking of an Entity <ent>

Implements Interface_GeneralModule.

Implemented in RWStepAP214_GeneralModule, RWHeaderSection_GeneralModule, and StepData_DefaultGeneral.

◆ CopyCase()

virtual void StepData_GeneralModule::CopyCase ( const Standard_Integer  casenum,
const Handle< Standard_Transient > &  entfrom,
const Handle< Standard_Transient > &  entto,
Interface_CopyTool TC 
) const
overridepure virtual

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

Implements Interface_GeneralModule.

Implemented in StepData_DefaultGeneral, RWStepAP214_GeneralModule, and RWHeaderSection_GeneralModule.

◆ FillSharedCase()

virtual void StepData_GeneralModule::FillSharedCase ( const Standard_Integer  casenum,
const Handle< Standard_Transient > &  ent,
Interface_EntityIterator iter 
) const
overridepure virtual

Specific filling of the list of Entities shared by an Entity <ent>. Can use the internal utility method Share, below.

Implements Interface_GeneralModule.

Implemented in RWStepAP214_GeneralModule, RWHeaderSection_GeneralModule, and StepData_DefaultGeneral.


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