a AttrList allows to record a list of attributes as Transients
which can be edited, changed ...
Each one is identified by a name
More...

#include <MoniTool_AttrList.hxx>

Public Member Functions
	MoniTool_AttrList ()
	Creates an AttrList, empty More...

	MoniTool_AttrList (const MoniTool_AttrList &other)
	Creates an AttrList from another one, definitions are shared (calls SameAttributes) More...

void	SetAttribute (const Standard_CString name, const Handle< Standard_Transient > &val)
	Adds an attribute with a given name (replaces the former one with the same name if already exists) More...

Standard_Boolean	RemoveAttribute (const Standard_CString name)
	Removes an attribute Returns True when done, False if this attribute did not exist More...

Standard_Boolean	GetAttribute (const Standard_CString name, const Handle< Standard_Type > &type, Handle< Standard_Transient > &val) const
	Returns an attribute from its name, filtered by a type If no attribute has this name, or if it is not kind of this type, <val> is Null and returned value is False Else, it is True More...

Handle_Standard_Transient	Attribute (const Standard_CString name) const
	Returns an attribute from its name. Null Handle if not recorded (whatever Transient, Integer, Real ...) Integer is recorded as IntVal Real is recorded as RealVal Text is recorded as HAsciiString More...

MoniTool_ValueType	AttributeType (const Standard_CString name) const
	Returns the type of an attribute : ValueInt , ValueReal , ValueText (String) , ValueIdent (any) or ValueVoid (not recorded) More...

void	SetIntegerAttribute (const Standard_CString name, const Standard_Integer val)
	Adds an integer value for an attribute More...

Standard_Boolean	GetIntegerAttribute (const Standard_CString name, Standard_Integer &val) const
	Returns an attribute from its name, as integer If no attribute has this name, or not an integer, <val> is 0 and returned value is False Else, it is True More...

Standard_Integer	IntegerAttribute (const Standard_CString name) const
	Returns an integer attribute from its name. 0 if not recorded More...

void	SetRealAttribute (const Standard_CString name, const Standard_Real val)
	Adds a real value for an attribute More...

Standard_Boolean	GetRealAttribute (const Standard_CString name, Standard_Real &val) const
	Returns an attribute from its name, as real If no attribute has this name, or not a real <val> is 0.0 and returned value is False Else, it is True More...

Standard_Real	RealAttribute (const Standard_CString name) const
	Returns a real attribute from its name. 0.0 if not recorded More...

void	SetStringAttribute (const Standard_CString name, const Standard_CString val)
	Adds a String value for an attribute More...

Standard_Boolean	GetStringAttribute (const Standard_CString name, Standard_CString &val) const
	Returns an attribute from its name, as String If no attribute has this name, or not a String <val> is 0.0 and returned value is False Else, it is True More...

Standard_CString	StringAttribute (const Standard_CString name) const
	Returns a String attribute from its name. "" if not recorded More...

Handle_Dico_DictionaryOfTransient	AttrList () const
	Returns the exhaustive list of attributes More...

void	SameAttributes (const MoniTool_AttrList &other)
	Gets the list of attributes from <other>, as such, i.e. not copied : attributes are shared, any attribute edited, added, or removed in <other> is also in <me> and vice versa The former list of attributes of <me> is dropped More...

void	GetAttributes (const MoniTool_AttrList &other, const Standard_CString fromname="", const Standard_Boolean copied=Standard_True)
	Gets the list of attributes from <other>, by copying it <br> By default, considers all the attributes from <other> <br> If <fromname> is given, considers only the attributes with <br> name beginning by <fromname> <br> For each attribute, if <copied> is True (D), its value is also copied if it is a basic type (Integer,Real,String), else it remains shared between <other> and <me> These new attributes are added to the existing ones in <me>, in case of same name, they replace the existing ones More...

Detailed Description

a AttrList allows to record a list of attributes as Transients
which can be edited, changed ...
Each one is identified by a name

Constructor & Destructor Documentation

MoniTool_AttrList::MoniTool_AttrList ( )

Creates an AttrList, empty

MoniTool_AttrList::MoniTool_AttrList ( const MoniTool_AttrList & other )

Creates an AttrList from another one, definitions are shared
(calls SameAttributes)

Member Function Documentation

Handle_Standard_Transient MoniTool_AttrList::Attribute ( const Standard_CString name ) const

Returns an attribute from its name. Null Handle if not
recorded (whatever Transient, Integer, Real ...)
Integer is recorded as IntVal
Real is recorded as RealVal
Text is recorded as HAsciiString

MoniTool_ValueType MoniTool_AttrList::AttributeType ( const Standard_CString name ) const

Returns the type of an attribute :
ValueInt , ValueReal , ValueText (String) , ValueIdent (any)
or ValueVoid (not recorded)

Handle_Dico_DictionaryOfTransient MoniTool_AttrList::AttrList ( ) const

Returns the exhaustive list of attributes

Standard_Boolean MoniTool_AttrList::GetAttribute	(	const Standard_CString	name,
		const Handle< Standard_Type > &	type,
		Handle< Standard_Transient > &	val
	)		const

Returns an attribute from its name, filtered by a type
If no attribute has this name, or if it is not kind of this
type, <val> is Null and returned value is False
Else, it is True

void MoniTool_AttrList::GetAttributes	(	const MoniTool_AttrList &	other,
		const Standard_CString	fromname = `""`,
		const Standard_Boolean	copied = `Standard_True`
	)

 Gets the list of attributes from <other>, by copying it <br>
      By default, considers all the attributes from <other> <br>
      If <fromname> is given, considers only the attributes with <br>
      name beginning by <fromname> <br>

For each attribute, if <copied> is True (D), its value is also
copied if it is a basic type (Integer,Real,String), else it
remains shared between <other> and <me>

These new attributes are added to the existing ones in <me>,
in case of same name, they replace the existing ones

Standard_Boolean MoniTool_AttrList::GetIntegerAttribute	(	const Standard_CString	name,
		Standard_Integer &	val
	)		const

Returns an attribute from its name, as integer
If no attribute has this name, or not an integer,
<val> is 0 and returned value is False
Else, it is True

Standard_Boolean MoniTool_AttrList::GetRealAttribute	(	const Standard_CString	name,
		Standard_Real &	val
	)		const

Returns an attribute from its name, as real
If no attribute has this name, or not a real
<val> is 0.0 and returned value is False
Else, it is True

Standard_Boolean MoniTool_AttrList::GetStringAttribute	(	const Standard_CString	name,
		Standard_CString &	val
	)		const

Returns an attribute from its name, as String
If no attribute has this name, or not a String
<val> is 0.0 and returned value is False
Else, it is True

Standard_Integer MoniTool_AttrList::IntegerAttribute ( const Standard_CString name ) const

Returns an integer attribute from its name. 0 if not recorded

Standard_Real MoniTool_AttrList::RealAttribute ( const Standard_CString name ) const

Returns a real attribute from its name. 0.0 if not recorded

Standard_Boolean MoniTool_AttrList::RemoveAttribute ( const Standard_CString name )

Removes an attribute
Returns True when done, False if this attribute did not exist

void MoniTool_AttrList::SameAttributes ( const MoniTool_AttrList & other )

Gets the list of attributes from <other>, as such, i.e.
not copied : attributes are shared, any attribute edited,
added, or removed in <other> is also in <me> and vice versa
The former list of attributes of <me> is dropped

void MoniTool_AttrList::SetAttribute	(	const Standard_CString	name,
		const Handle< Standard_Transient > &	val
	)

Adds an attribute with a given name (replaces the former one
with the same name if already exists)

void MoniTool_AttrList::SetIntegerAttribute	(	const Standard_CString	name,
		const Standard_Integer	val
	)

Adds an integer value for an attribute

void MoniTool_AttrList::SetRealAttribute	(	const Standard_CString	name,
		const Standard_Real	val
	)

Adds a real value for an attribute

void MoniTool_AttrList::SetStringAttribute	(	const Standard_CString	name,
		const Standard_CString	val
	)

Adds a String value for an attribute

Standard_CString MoniTool_AttrList::StringAttribute ( const Standard_CString name ) const

Returns a String attribute from its name. "" if not recorded

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

MoniTool_AttrList.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation