Open CASCADE Technology  7.7.0.dev
Public Member Functions

TransferBRep_ShapeListBinder Class Reference

This binder binds several (a list of) shapes with a starting entity, when this entity itself corresponds to a simple list of shapes. Each part is not seen as a sub-result of an independent component, but as an item of a built-in list. More...

#include <TransferBRep_ShapeListBinder.hxx>

Inheritance diagram for TransferBRep_ShapeListBinder:
Inheritance graph
[legend]

Public Member Functions

 TransferBRep_ShapeListBinder ()
 
 TransferBRep_ShapeListBinder (const Handle< TopTools_HSequenceOfShape > &list)
 
virtual Standard_Boolean IsMultiple () const override
 Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes. More...
 
Handle< Standard_TypeResultType () const override
 Returns the Type which characterizes the Result (if known) More...
 
Standard_CString ResultTypeName () const override
 Returns the Name of the Type which characterizes the Result Can be returned even if ResultType itself is unknown. More...
 
void AddResult (const TopoDS_Shape &res)
 Adds an item to the result list. More...
 
Handle< TopTools_HSequenceOfShape > Result () const
 
void SetResult (const Standard_Integer num, const TopoDS_Shape &res)
 Changes an already defined sub-result. More...
 
Standard_Integer NbShapes () const
 
const TopoDS_ShapeShape (const Standard_Integer num) const
 
TopAbs_ShapeEnum ShapeType (const Standard_Integer num) const
 
TopoDS_Vertex Vertex (const Standard_Integer num) const
 
TopoDS_Edge Edge (const Standard_Integer num) const
 
TopoDS_Wire Wire (const Standard_Integer num) const
 
TopoDS_Face Face (const Standard_Integer num) const
 
TopoDS_Shell Shell (const Standard_Integer num) const
 
TopoDS_Solid Solid (const Standard_Integer num) const
 
TopoDS_CompSolid CompSolid (const Standard_Integer num) const
 
TopoDS_Compound Compound (const Standard_Integer num) const
 
- Public Member Functions inherited from Transfer_Binder
void Merge (const Handle< Transfer_Binder > &other)
 Merges basic data (Check, ExecStatus) from another Binder but keeps its result. Used when a binder is replaced by another one, this allows to keep messages. More...
 
void AddResult (const Handle< Transfer_Binder > &next)
 Adds a next result (at the end of the list) Remark : this information is not processed by Merge. More...
 
Handle< Transfer_BinderNextResult () const
 Returns the next result, Null if none. More...
 
Standard_Boolean HasResult () const
 Returns True if a Result is available (StatusResult = Defined) A Unique Result will be gotten by Result (which must be defined in each sub-class according to result type) For a Multiple Result, see class MultipleBinder For other case, specific access has to be forecast. More...
 
void SetAlreadyUsed ()
 Declares that result is now used by another one, it means that it cannot be modified (by Rebind) More...
 
Transfer_StatusResult Status () const
 Returns status, which can be Initial (not yet done), Made (a result is recorded, not yet shared), Used (it is shared and cannot be modified) More...
 
Transfer_StatusExec StatusExec () const
 Returns execution status. More...
 
void SetStatusExec (const Transfer_StatusExec stat)
 Modifies execution status; called by TransferProcess only (for StatusError, rather use SetError, below) More...
 
void AddFail (const Standard_CString mess, const Standard_CString orig="")
 Used to declare an individual transfer as being erroneous (Status is set to Void, StatusExec is set to Error, <errmess> is added to Check's list of Fails) It is possible to record several messages of error. More...
 
void AddWarning (const Standard_CString mess, const Standard_CString orig="")
 Used to attach a Warning Message to an individual Transfer It has no effect on the Status. More...
 
const Handle< Interface_CheckCheck () const
 Returns Check which stores Fail messages Note that no Entity is associated in this Check. More...
 
Handle< Interface_CheckCCheck ()
 Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it) More...
 
 ~Transfer_Binder ()
 Destructor. 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...
 
- Protected Member Functions inherited from Transfer_Binder
 Transfer_Binder ()
 Sets fields at initial values. More...
 
void SetResultPresent ()
 Used to declare that a result is recorded for an individual transfer (works by setting StatusResult to Defined) More...
 

Detailed Description

This binder binds several (a list of) shapes with a starting entity, when this entity itself corresponds to a simple list of shapes. Each part is not seen as a sub-result of an independent component, but as an item of a built-in list.

Constructor & Destructor Documentation

◆ TransferBRep_ShapeListBinder() [1/2]

TransferBRep_ShapeListBinder::TransferBRep_ShapeListBinder ( )

◆ TransferBRep_ShapeListBinder() [2/2]

TransferBRep_ShapeListBinder::TransferBRep_ShapeListBinder ( const Handle< TopTools_HSequenceOfShape > &  list)

Member Function Documentation

◆ AddResult()

void TransferBRep_ShapeListBinder::AddResult ( const TopoDS_Shape res)

Adds an item to the result list.

◆ Compound()

TopoDS_Compound TransferBRep_ShapeListBinder::Compound ( const Standard_Integer  num) const

◆ CompSolid()

TopoDS_CompSolid TransferBRep_ShapeListBinder::CompSolid ( const Standard_Integer  num) const

◆ Edge()

TopoDS_Edge TransferBRep_ShapeListBinder::Edge ( const Standard_Integer  num) const

◆ Face()

TopoDS_Face TransferBRep_ShapeListBinder::Face ( const Standard_Integer  num) const

◆ IsMultiple()

virtual Standard_Boolean TransferBRep_ShapeListBinder::IsMultiple ( ) const
overridevirtual

Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes.

Reimplemented from Transfer_Binder.

◆ NbShapes()

Standard_Integer TransferBRep_ShapeListBinder::NbShapes ( ) const

◆ Result()

Handle< TopTools_HSequenceOfShape > TransferBRep_ShapeListBinder::Result ( ) const

◆ ResultType()

Handle< Standard_Type > TransferBRep_ShapeListBinder::ResultType ( ) const
overridevirtual

Returns the Type which characterizes the Result (if known)

Implements Transfer_Binder.

◆ ResultTypeName()

Standard_CString TransferBRep_ShapeListBinder::ResultTypeName ( ) const
overridevirtual

Returns the Name of the Type which characterizes the Result Can be returned even if ResultType itself is unknown.

Implements Transfer_Binder.

◆ SetResult()

void TransferBRep_ShapeListBinder::SetResult ( const Standard_Integer  num,
const TopoDS_Shape res 
)

Changes an already defined sub-result.

◆ Shape()

const TopoDS_Shape& TransferBRep_ShapeListBinder::Shape ( const Standard_Integer  num) const

◆ ShapeType()

TopAbs_ShapeEnum TransferBRep_ShapeListBinder::ShapeType ( const Standard_Integer  num) const

◆ Shell()

TopoDS_Shell TransferBRep_ShapeListBinder::Shell ( const Standard_Integer  num) const

◆ Solid()

TopoDS_Solid TransferBRep_ShapeListBinder::Solid ( const Standard_Integer  num) const

◆ Vertex()

TopoDS_Vertex TransferBRep_ShapeListBinder::Vertex ( const Standard_Integer  num) const

◆ Wire()

TopoDS_Wire TransferBRep_ShapeListBinder::Wire ( const Standard_Integer  num) const

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