A ParamEditor gives access for edition to a list of TypedValue (i.e. of Static too) Its definition is made of the TypedValue to edit themselves, and can add some constants, which can then be displayed but not changed (for instance, system name, processor version ...) More...

#include <IFSelect_ParamEditor.hxx>

Inheritance diagram for IFSelect_ParamEditor:

[legend]

Public Member Functions
	IFSelect_ParamEditor (const int nbmax=100, const char *const label="")
	Creates a ParamEditor, empty, with a maximum count of params (default is 100) And a label, by default it will be "Param Editor".

void	AddValue (const occ::handle< Interface_TypedValue > &val, const char *const shortname="")
	Adds a TypedValue By default, its short name equates its complete name, it can be made explicit.

void	AddConstantText (const char const val, const char const shortname, const char *const completename="")
	Adds a Constant Text, it will be Read Only By default, its long name equates its shortname.

TCollection_AsciiString	Label () const override
	Returns the specific label.

bool	Recognize (const occ::handle< IFSelect_EditForm > &form) const override
	Tells if this Editor can work on this EditForm and its content (model, entity ?)

occ::handle< TCollection_HAsciiString >	StringValue (const occ::handle< IFSelect_EditForm > &form, const int num) const override
	Returns the value of an EditForm, for a given item (if not a list. for a list, a Null String may be returned)

bool	Load (const occ::handle< IFSelect_EditForm > &form, const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model) const override
	Loads original values from some data, to an EditForm Remark: <ent> may be Null, this means all <model> is concerned Also <model> may be Null, if no context applies for <ent> And both <ent> and <model> may be Null, for a full static editor.

bool	Apply (const occ::handle< IFSelect_EditForm > &form, const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model) const override
	Applies modified values of the EditForm with some data Remark: <ent> may be Null, this means all <model> is concerned Also <model> may be Null, if no context applies for <ent> And both <ent> and <model> may be Null, for a full static editor.

Public Member Functions inherited from IFSelect_Editor
void	SetValue (const int num, const occ::handle< Interface_TypedValue > &typval, const char *const shortname="", const IFSelect_EditValue accessmode=IFSelect_Editable)
	Sets a Typed Value for a given ident and short name, with an Edit Mode.

void	SetList (const int num, const int max=0)
	Sets a parameter to be a List max < 0 : not for a list (set when starting) max = 0 : list with no length limit (default for SetList) max > 0 : list limited to <max> items.

int	NbValues () const
	Returns the count of Typed Values.

occ::handle< Interface_TypedValue >	TypedValue (const int num) const
	Returns a Typed Value from its ident.

bool	IsList (const int num) const
	Tells if a parameter is a list.

int	MaxList (const int num) const
	Returns max length allowed for a list = 0 means : list with no limit < 0 means : not a list.

const char *	Name (const int num, const bool isshort=false) const
	Returns the name of a Value (complete or short) from its ident Short Name can be empty.

IFSelect_EditValue	EditMode (const int num) const
	Returns the edit mode of a Value.

int	NameNumber (const char *const name) const
	Returns the number (ident) of a Value, from its name, short or complete. If not found, returns 0.

void	PrintNames (Standard_OStream &S) const

void	PrintDefs (Standard_OStream &S, const bool labels=false) const

int	MaxNameLength (const int what) const
	Returns the MaxLength of, according to what : <what> = -1 : length of short names <what> = 0 : length of complete names <what> = 1 : length of values labels.

virtual occ::handle< IFSelect_EditForm >	Form (const bool readonly, const bool undoable=true) const
	Builds and Returns an EditForm, empty (no data yet) Can be redefined to return a specific type of EditForm.

virtual occ::handle< IFSelect_ListEditor >	ListEditor (const int num) const
	Returns a ListEditor for a parameter which is a List Default returns a basic ListEditor for a List, a Null Handle if <num> is not for a List. Can be redefined.

virtual occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > >	ListValue (const occ::handle< IFSelect_EditForm > &form, const int num) const
	Returns the value of an EditForm as a List, for a given item If not a list, a Null Handle should be returned Default returns a Null Handle, because many Editors have no list to edit. To be redefined as required.

virtual bool	Update (const occ::handle< IFSelect_EditForm > &form, const int num, const occ::handle< TCollection_HAsciiString > &newval, const bool enforce) const
	Updates the EditForm when a parameter is modified I.E. default does nothing, can be redefined, as follows : Returns True when done (even if does nothing), False in case of refuse (for instance, if the new value is not suitable) <num> is the rank of the parameter for the EDITOR itself <enforce> True means that protected parameters can be touched.

virtual bool	UpdateList (const occ::handle< IFSelect_EditForm > &form, const int num, const occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > &newlist, const bool enforce) const
	Acts as Update, but when the value is a list.

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 ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static occ::handle< IFSelect_ParamEditor >	StaticEditor (const occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > &list, const char *const label="")
	Returns a ParamEditor to work on the Static Parameters of which names are listed in Handle if null or empty.

Static Public Member Functions inherited from Standard_Transient
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.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Member Functions inherited from IFSelect_Editor
	IFSelect_Editor (const int nbval)
	Prepares the list of Typed Values (gives its count) This count can be tuned later, to a LOWER value, this allows to initialize with a "maximum reservation" then cut the extra.

void	SetNbValues (const int nbval)
	Adjusts the true count of values. It can be LOWER or equal to the initial size (which then acts as a reservation), but never greater.

Detailed Description

A ParamEditor gives access for edition to a list of TypedValue (i.e. of Static too) Its definition is made of the TypedValue to edit themselves, and can add some constants, which can then be displayed but not changed (for instance, system name, processor version ...)

I.E. it gives a way of editing or at least displaying parameters as global

Constructor & Destructor Documentation

◆ IFSelect_ParamEditor()

IFSelect_ParamEditor::IFSelect_ParamEditor	(	const int	nbmax = 100,
		const char *const	label = "" )

Creates a ParamEditor, empty, with a maximum count of params (default is 100) And a label, by default it will be "Param Editor".

Member Function Documentation

◆ AddConstantText()

void IFSelect_ParamEditor::AddConstantText	(	const char *const	val,
		const char *const	shortname,
		const char *const	completename = "" )

Adds a Constant Text, it will be Read Only By default, its long name equates its shortname.

◆ AddValue()

void IFSelect_ParamEditor::AddValue	(	const occ::handle< Interface_TypedValue > &	val,
		const char *const	shortname = "" )

Adds a TypedValue By default, its short name equates its complete name, it can be made explicit.

◆ Apply()

bool IFSelect_ParamEditor::Apply	(	const occ::handle< IFSelect_EditForm > &	form,
		const occ::handle< Standard_Transient > &	ent,
		const occ::handle< Interface_InterfaceModel > &	model ) const

overridevirtual

Applies modified values of the EditForm with some data Remark: <ent> may be Null, this means all <model> is concerned Also <model> may be Null, if no context applies for <ent> And both <ent> and <model> may be Null, for a full static editor.

Implements IFSelect_Editor.

◆ Label()

TCollection_AsciiString IFSelect_ParamEditor::Label ( ) const

overridevirtual

Returns the specific label.

Implements IFSelect_Editor.

◆ Load()

bool IFSelect_ParamEditor::Load	(	const occ::handle< IFSelect_EditForm > &	form,
		const occ::handle< Standard_Transient > &	ent,
		const occ::handle< Interface_InterfaceModel > &	model ) const

overridevirtual

Loads original values from some data, to an EditForm Remark: <ent> may be Null, this means all <model> is concerned Also <model> may be Null, if no context applies for <ent> And both <ent> and <model> may be Null, for a full static editor.

Implements IFSelect_Editor.

◆ Recognize()

bool IFSelect_ParamEditor::Recognize ( const occ::handle< IFSelect_EditForm > & form ) const

overridevirtual

Tells if this Editor can work on this EditForm and its content (model, entity ?)

Implements IFSelect_Editor.

◆ StaticEditor()

static occ::handle< IFSelect_ParamEditor > IFSelect_ParamEditor::StaticEditor	(	const occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > &	list,
		const char *const	label = "" )

static

Returns a ParamEditor to work on the Static Parameters of which names are listed in

Handle if

null or empty.

◆ StringValue()

occ::handle< TCollection_HAsciiString > IFSelect_ParamEditor::StringValue	(	const occ::handle< IFSelect_EditForm > &	form,
		const int	num ) const

overridevirtual

Returns the value of an EditForm, for a given item (if not a list. for a list, a Null String may be returned)

Implements IFSelect_Editor.

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

IFSelect_ParamEditor.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IFSelect_ParamEditor()

Member Function Documentation

◆ AddConstantText()

◆ AddValue()

◆ Apply()

◆ Label()

◆ Load()

◆ Recognize()

◆ StaticEditor()

◆ StringValue()