Open CASCADE Technology  7.4.1.dev
Public Member Functions
XSControl_Vars Class Reference

Defines a receptacle for externally defined variables, each one has a name. More...

#include <XSControl_Vars.hxx>

Inheritance diagram for XSControl_Vars:
Inheritance graph
[legend]

Public Member Functions

 XSControl_Vars ()
 
virtual void Set (const Standard_CString name, const Handle< Standard_Transient > &val)
 
virtual Handle< Standard_TransientGet (Standard_CString &name) const
 
virtual Handle< Geom_GeometryGetGeom (Standard_CString &name) const
 
virtual Handle< Geom2d_CurveGetCurve2d (Standard_CString &name) const
 
virtual Handle< Geom_CurveGetCurve (Standard_CString &name) const
 
virtual Handle< Geom_SurfaceGetSurface (Standard_CString &name) const
 
virtual void SetPoint (const Standard_CString name, const gp_Pnt &val)
 
virtual void SetPoint2d (const Standard_CString name, const gp_Pnt2d &val)
 
virtual Standard_Boolean GetPoint (Standard_CString &name, gp_Pnt &pnt) const
 
virtual Standard_Boolean GetPoint2d (Standard_CString &name, gp_Pnt2d &pnt) const
 
virtual void SetShape (const Standard_CString name, const TopoDS_Shape &val)
 
virtual TopoDS_Shape GetShape (Standard_CString &name) const
 
- 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

Defines a receptacle for externally defined variables, each one has a name.

I.E. a WorkSession for XSTEP is generally used inside a context, which brings variables, especially shapes and geometries. For instance DRAW or an application engine

This class provides a common form for this. It also provides a default implementation (locally recorded variables in a dictionary), but which is aimed to be redefined

Constructor & Destructor Documentation

◆ XSControl_Vars()

XSControl_Vars::XSControl_Vars ( )

Member Function Documentation

◆ Get()

virtual Handle< Standard_Transient > XSControl_Vars::Get ( Standard_CString name) const
virtual

◆ GetCurve()

virtual Handle< Geom_Curve > XSControl_Vars::GetCurve ( Standard_CString name) const
virtual

Reimplemented in XSDRAW_Vars.

◆ GetCurve2d()

virtual Handle< Geom2d_Curve > XSControl_Vars::GetCurve2d ( Standard_CString name) const
virtual

Reimplemented in XSDRAW_Vars.

◆ GetGeom()

virtual Handle< Geom_Geometry > XSControl_Vars::GetGeom ( Standard_CString name) const
virtual

Reimplemented in XSDRAW_Vars.

◆ GetPoint()

virtual Standard_Boolean XSControl_Vars::GetPoint ( Standard_CString name,
gp_Pnt pnt 
) const
virtual

Reimplemented in XSDRAW_Vars.

◆ GetPoint2d()

virtual Standard_Boolean XSControl_Vars::GetPoint2d ( Standard_CString name,
gp_Pnt2d pnt 
) const
virtual

Reimplemented in XSDRAW_Vars.

◆ GetShape()

virtual TopoDS_Shape XSControl_Vars::GetShape ( Standard_CString name) const
virtual

Reimplemented in XSDRAW_Vars.

◆ GetSurface()

virtual Handle< Geom_Surface > XSControl_Vars::GetSurface ( Standard_CString name) const
virtual

Reimplemented in XSDRAW_Vars.

◆ Set()

virtual void XSControl_Vars::Set ( const Standard_CString  name,
const Handle< Standard_Transient > &  val 
)
virtual

Reimplemented in XSDRAW_Vars.

◆ SetPoint()

virtual void XSControl_Vars::SetPoint ( const Standard_CString  name,
const gp_Pnt val 
)
virtual

Reimplemented in XSDRAW_Vars.

◆ SetPoint2d()

virtual void XSControl_Vars::SetPoint2d ( const Standard_CString  name,
const gp_Pnt2d val 
)
virtual

Reimplemented in XSDRAW_Vars.

◆ SetShape()

virtual void XSControl_Vars::SetShape ( const Standard_CString  name,
const TopoDS_Shape val 
)
virtual

Reimplemented in XSDRAW_Vars.


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