OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# DataExchange
TKXSBase
MoniTool

# MoniTool_AttrList Class Reference

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

`#include <MoniTool_AttrList.hxx>`

## Public Member Functions
void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | MoniTool_AttrList ()
| Creates an AttrList, empty .
Standard_EXPORT | MoniTool_AttrList (const MoniTool_AttrList &other)
| Creates an AttrList from another one, definitions are shared (calls SameAttributes) .
Standard_EXPORT 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) .
Standard_EXPORT Standard_Boolean | RemoveAttribute (const Standard_CString name)
| Removes an attribute Returns True when done, False if this attribute did not exist .
Standard_EXPORT 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 .
Standard_EXPORT 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 .
Standard_EXPORT MoniTool_ValueType | AttributeType (const Standard_CString name) const
| Returns the type of an attribute : ValueInt , ValueReal , ValueText (String) , ValueIdent (any) or ValueVoid (not recorded) .
Standard_EXPORT void | SetIntegerAttribute (const Standard_CString name, const Standard_Integer val)
| Adds an integer value for an attribute .
Standard_EXPORT 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 .
Standard_EXPORT Standard_Integer | IntegerAttribute (const Standard_CString name) const
| Returns an integer attribute from its name. 0 if not recorded .
Standard_EXPORT void | SetRealAttribute (const Standard_CString name, const Standard_Real val)
| Adds a real value for an attribute .
Standard_EXPORT 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 .
Standard_EXPORT Standard_Real | RealAttribute (const Standard_CString name) const
| Returns a real attribute from its name. 0.0 if not recorded .
Standard_EXPORT void | SetStringAttribute (const Standard_CString name, const Standard_CString val)
| Adds a String value for an attribute .
Standard_EXPORT 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 .
Standard_EXPORT Standard_CString | StringAttribute (const Standard_CString name) const
| Returns a String attribute from its name. "" if not recorded .
Standard_EXPORT Handle_Dico_DictionaryOfTransient | AttrList () const
| Returns the exhaustive list of attributes .
Standard_EXPORT 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 .
Standard_EXPORT 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 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 .
## Private Attributes
Handle_Dico_DictionaryOfTransient | theattrib

## Constructor & Destructor Documentation

Standard_EXPORT MoniTool_AttrList::MoniTool_AttrList | ( |  | ) |

Standard_EXPORT MoniTool_AttrList::MoniTool_AttrList | ( | const MoniTool_AttrList & | other | ) |

## Member Function Documentation

Standard_EXPORT Handle_Standard_Transient MoniTool_AttrList::Attribute | ( | const Standard_CString | name | ) | const

Standard_EXPORT MoniTool_ValueType MoniTool_AttrList::AttributeType | ( | const Standard_CString | name | ) | const

Standard_EXPORT Handle_Dico_DictionaryOfTransient MoniTool_AttrList::AttrList | ( |  | ) | const

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

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

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

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

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

Standard_EXPORT Standard_Integer MoniTool_AttrList::IntegerAttribute | ( | const Standard_CString | name | ) | const

void MoniTool_AttrList::operator delete | ( | void * | anAddress | ) | `[inline]`

void* MoniTool_AttrList::operator new | ( | size_t | size | ) | `[inline]`

void* MoniTool_AttrList::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Standard_EXPORT Standard_Real MoniTool_AttrList::RealAttribute | ( | const Standard_CString | name | ) | const

Standard_EXPORT Standard_Boolean MoniTool_AttrList::RemoveAttribute | ( | const Standard_CString | name | ) |

Standard_EXPORT void MoniTool_AttrList::SameAttributes | ( | const MoniTool_AttrList & | other | ) |

Standard_EXPORT void MoniTool_AttrList::SetAttribute | ( | const Standard_CString | name,
|  | const Handle(Standard_Transient)& | val
| ) |

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

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

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

Standard_EXPORT Standard_CString MoniTool_AttrList::StringAttribute | ( | const Standard_CString | name | ) | const

## Field Documentation

Handle_Dico_DictionaryOfTransient MoniTool_AttrList::theattrib`[private]`

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

- MoniTool_AttrList.hxx