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.

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

void	SetAttribute (const char *const name, const occ::handle< Standard_Transient > &val)
	Adds an attribute with a given name (replaces the former one with the same name if already exists)

bool	RemoveAttribute (const char *const name)
	Removes an attribute Returns True when done, False if this attribute did not exist.

bool	GetAttribute (const char *const name, const occ::handle< Standard_Type > &type, occ::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.

occ::handle< Standard_Transient >	Attribute (const char *const 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	AttributeType (const char *const name) const
	Returns the type of an attribute: ValueInt, ValueReal, ValueText (String), ValueIdent (any) or ValueVoid (not recorded)

void	SetIntegerAttribute (const char *const name, const int val)
	Adds an integer value for an attribute.

bool	GetIntegerAttribute (const char *const name, int &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.

int	IntegerAttribute (const char *const name) const
	Returns an integer attribute from its name. 0 if not recorded.

void	SetRealAttribute (const char *const name, const double val)
	Adds a real value for an attribute.

bool	GetRealAttribute (const char *const name, double &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.

double	RealAttribute (const char *const name) const
	Returns a real attribute from its name. 0.0 if not recorded.

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

bool	GetStringAttribute (const char const name, const char &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.

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

const NCollection_DataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > &	AttrList () const
	Returns the exhaustive list of attributes.

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.

void	GetAttributes (const MoniTool_AttrList &other, const char *const fromname="", const bool copied=true)
	Gets the list of attributes from <other>, by copying it By default, considers all the attributes from <other> If <fromname> is given, considers only the attributes with name beginning by <fromname>

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() [1/2]

MoniTool_AttrList::MoniTool_AttrList ( )

Creates an AttrList, empty.

◆ MoniTool_AttrList() [2/2]

MoniTool_AttrList::MoniTool_AttrList ( const MoniTool_AttrList & other )

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

Member Function Documentation

◆ Attribute()

occ::handle< Standard_Transient > MoniTool_AttrList::Attribute ( const char *const 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.

◆ AttributeType()

MoniTool_ValueType MoniTool_AttrList::AttributeType ( const char *const name ) const

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

◆ AttrList()

const NCollection_DataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > & MoniTool_AttrList::AttrList ( ) const

Returns the exhaustive list of attributes.

◆ GetAttribute()

bool MoniTool_AttrList::GetAttribute	(	const char *const	name,
		const occ::handle< Standard_Type > &	type,
		occ::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.

◆ GetAttributes()

void MoniTool_AttrList::GetAttributes	(	const MoniTool_AttrList &	other,
		const char *const	fromname = "",
		const bool	copied = true )

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

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

◆ GetIntegerAttribute()

bool MoniTool_AttrList::GetIntegerAttribute	(	const char *const	name,
		int &	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.

◆ GetRealAttribute()

bool MoniTool_AttrList::GetRealAttribute	(	const char *const	name,
		double &	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.

◆ GetStringAttribute()

bool MoniTool_AttrList::GetStringAttribute	(	const char *const	name,
		const char *&	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.

◆ IntegerAttribute()

int MoniTool_AttrList::IntegerAttribute ( const char *const name ) const

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

◆ RealAttribute()

double MoniTool_AttrList::RealAttribute ( const char *const name ) const

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

◆ RemoveAttribute()

bool MoniTool_AttrList::RemoveAttribute ( const char *const name )

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

◆ SameAttributes()

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.

◆ SetAttribute()

void MoniTool_AttrList::SetAttribute	(	const char *const	name,
		const occ::handle< Standard_Transient > &	val )

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

◆ SetIntegerAttribute()

void MoniTool_AttrList::SetIntegerAttribute	(	const char *const	name,
		const int	val )

Adds an integer value for an attribute.

◆ SetRealAttribute()

void MoniTool_AttrList::SetRealAttribute	(	const char *const	name,
		const double	val )

Adds a real value for an attribute.

◆ SetStringAttribute()

void MoniTool_AttrList::SetStringAttribute	(	const char *const	name,
		const char *const	val )

Adds a String value for an attribute.

◆ StringAttribute()

const char * MoniTool_AttrList::StringAttribute ( const char *const 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