IFSelect_Functions Class Reference

Functions gives access to all the actions which can be commanded with the resources provided by IFSelect : especially WorkSession and various types of Selections and Dispatches. More...

#include <IFSelect_Functions.hxx>

Static Public Member Functions
static occ::handle< Standard_Transient >	GiveEntity (const occ::handle< IFSelect_WorkSession > &WS, const char *const name="")
	Takes the name of an entity, either as argument, or (if <name> is empty) on keyboard, and returns the entity name can be a label or a number (in alphanumeric), it is searched by NumberFromLabel from WorkSession. If <name> doesn't match en entity, a Null Handle is returned.
static int	GiveEntityNumber (const occ::handle< IFSelect_WorkSession > &WS, const char *const name="")
	Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle.
static occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	GiveList (const occ::handle< IFSelect_WorkSession > &WS, const char *const first="", const char *const second="")
	Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this entity if <first> is the name of a Selection in <WS>, and <second> not defined, the standard result of this Selection if <first> is for a Selection and <second> is defined, the standard result of this selection from the list computed with <second> (an entity or a selection) If <second> is erroneous, it is ignored.
static occ::handle< IFSelect_Dispatch >	GiveDispatch (const occ::handle< IFSelect_WorkSession > &WS, const char *const name, const bool mode=true)
	Evaluates and returns a Dispatch, from data of a WorkSession if <mode> is False, searches for exact name of Dispatch in WS Else (D), allows a parameter between brackets : ex.: dispatch_name(parameter) The parameter can be: an integer for DispPerCount or DispPerFiles or the name of a Signature for DispPerSignature Returns Null Handle if not found not well evaluated.
static void	Init ()
	Defines and loads all basic functions (as ActFunc)

Detailed Description

Functions gives access to all the actions which can be commanded with the resources provided by IFSelect : especially WorkSession and various types of Selections and Dispatches.

It works by adding functions by method Init

Member Function Documentation

GiveDispatch()

static occ::handle< IFSelect_Dispatch > IFSelect_Functions::GiveDispatch ( const occ::handle< IFSelect_WorkSession > & WS, const char *const name, const bool mode = true )

static

Evaluates and returns a Dispatch, from data of a WorkSession if <mode> is False, searches for exact name of Dispatch in WS Else (D), allows a parameter between brackets : ex.: dispatch_name(parameter) The parameter can be: an integer for DispPerCount or DispPerFiles or the name of a Signature for DispPerSignature Returns Null Handle if not found not well evaluated.

GiveEntity()

static occ::handle< Standard_Transient > IFSelect_Functions::GiveEntity ( const occ::handle< IFSelect_WorkSession > & WS, const char *const name = "" )

static

Takes the name of an entity, either as argument, or (if <name> is empty) on keyboard, and returns the entity name can be a label or a number (in alphanumeric), it is searched by NumberFromLabel from WorkSession. If <name> doesn't match en entity, a Null Handle is returned.

GiveEntityNumber()

static int IFSelect_Functions::GiveEntityNumber ( const occ::handle< IFSelect_WorkSession > & WS, const char *const name = "" )

static

Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle.

GiveList()

static occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > IFSelect_Functions::GiveList ( const occ::handle< IFSelect_WorkSession > & WS, const char *const first = "", const char *const second = "" )

static

Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this entity if <first> is the name of a Selection in <WS>, and <second> not defined, the standard result of this Selection if <first> is for a Selection and <second> is defined, the standard result of this selection from the list computed with <second> (an entity or a selection) If <second> is erroneous, it is ignored.

Init()

static void IFSelect_Functions::Init ( )

static

Defines and loads all basic functions (as ActFunc)

---

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

• IFSelect_Functions.hxx