TransferBRep_ShapeBinder Class Reference

A ShapeBinder is a BinderOfShape with some additional services to cast the Result under various kinds of Shapes. More...

#include <TransferBRep_ShapeBinder.hxx>

Inheritance diagram for TransferBRep_ShapeBinder:

Public Member Functions
	TransferBRep_ShapeBinder ()
	Creates an empty ShapeBinder.
	TransferBRep_ShapeBinder (const TopoDS_Shape &res)
	Creates a ShapeBinder with a result.
TopAbs_ShapeEnum	ShapeType () const
	Returns the Type of the Shape Result (under TopAbs form)
TopoDS_Vertex	Vertex () const
TopoDS_Edge	Edge () const
TopoDS_Wire	Wire () const
TopoDS_Face	Face () const
TopoDS_Shell	Shell () const
TopoDS_Solid	Solid () const
TopoDS_CompSolid	CompSolid () const
TopoDS_Compound	Compound () const
Public Member Functions inherited from TransferBRep_BinderOfShape
	TransferBRep_BinderOfShape ()
	normal standard constructor, creates an empty BinderOfShape
	TransferBRep_BinderOfShape (const TopoDS_Shape &res)
	constructor which in the same time defines the result Returns True if a starting object is bound with SEVERAL results : Here, returns always False But it can have next results
Handle< Standard_Type >	ResultType () const override
	Returns the Type permitted for the Result, i.e. the Type of the Parameter Class <Shape from TopoDS> (statically defined)
Standard_CString	ResultTypeName () const override
	Returns the Type Name computed for the Result (dynamic)
void	SetResult (const TopoDS_Shape &res)
	Defines the Result.
const TopoDS_Shape &	Result () const
	Returns the defined Result, if there is one.
TopoDS_Shape &	CResult ()
	Returns the defined Result, if there is one, and allows to change it (avoids Result + SetResult). Admits that Result can be not yet defined Warning : a call to CResult causes Result to be known as defined.
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.
virtual Standard_Boolean	IsMultiple () const
	Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes.
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.
Handle< Transfer_Binder >	NextResult () const
	Returns the next result, Null if none.
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.
void	SetAlreadyUsed ()
	Declares that result is now used by another one, it means that it cannot be modified (by Rebind)
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)
Transfer_StatusExec	StatusExec () const
	Returns execution status.
void	SetStatusExec (const Transfer_StatusExec stat)
	Modifies execution status; called by TransferProcess only (for StatusError, rather use SetError, below)
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.
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.
const Handle< Interface_Check >	Check () const
	Returns Check which stores Fail messages Note that no Entity is associated in this Check.
Handle< Interface_Check >	CCheck ()
	Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it)
	~Transfer_Binder ()
	Destructor.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (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_Transient *	This () 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
typedef void	base_type
	Returns a type descriptor about this object.
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 Transfer_Binder
	Transfer_Binder ()
	Sets fields at initial values.
void	SetResultPresent ()
	Used to declare that a result is recorded for an individual transfer (works by setting StatusResult to Defined)

Detailed Description

A ShapeBinder is a BinderOfShape with some additional services to cast the Result under various kinds of Shapes.

Constructor & Destructor Documentation

TransferBRep_ShapeBinder() [1/2]

TransferBRep_ShapeBinder::TransferBRep_ShapeBinder

(

)

Creates an empty ShapeBinder.

TransferBRep_ShapeBinder() [2/2]

TransferBRep_ShapeBinder::TransferBRep_ShapeBinder

(

const TopoDS_Shape &

res

)

Creates a ShapeBinder with a result.

Member Function Documentation

Compound()

TopoDS_Compound TransferBRep_ShapeBinder::Compound

(

)

const

CompSolid()

TopoDS_CompSolid TransferBRep_ShapeBinder::CompSolid

(

)

const

Edge()

TopoDS_Edge TransferBRep_ShapeBinder::Edge

(

)

const

Face()

TopoDS_Face TransferBRep_ShapeBinder::Face

(

)

const

ShapeType()

TopAbs_ShapeEnum TransferBRep_ShapeBinder::ShapeType

(

)

const

Returns the Type of the Shape Result (under TopAbs form)

Shell()

TopoDS_Shell TransferBRep_ShapeBinder::Shell

(

)

const

Solid()

TopoDS_Solid TransferBRep_ShapeBinder::Solid

(

)

const

Vertex()

TopoDS_Vertex TransferBRep_ShapeBinder::Vertex

(

)

const

Wire()

TopoDS_Wire TransferBRep_ShapeBinder::Wire

(

)

const

---

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

• TransferBRep_ShapeBinder.hxx