Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
Materials_MaterialsDictionary Class Reference

This class creates a dictionary of materials.
More...

#include <Materials_MaterialsDictionary.hxx>

Inheritance diagram for Materials_MaterialsDictionary:
Inheritance graph
[legend]

Public Member Functions

 Materials_MaterialsDictionary ()
 Returns a MaterialsDictionary object which contains
the sequence of all the materials the user wants to
consider.
More...
 
Handle_Materials_Material Material (const Standard_CString amaterial) const
 Retrieves from the dictionary the object material with
<amaterial> as name. If <amaterial> does not exist in
the dictionary an exeption is raised.
More...
 
Standard_Boolean ExistMaterial (const Standard_CString aName) const
 True if the materialofname aName exists ...
More...
 
Standard_Integer NumberOfMaterials () const
 Returns the number of materials previously stored in
the dictionary.
More...
 
Handle_Materials_Material Material (const Standard_Integer anindex) const
 This method used with the previous one, allow the
exploration of all the dictionary. It returns a
Material instance.
More...
 
Standard_Boolean UpToDate () const
 Returns true if there has been no modification of the
file Materials.dat since the creation of the dictionary
object, false otherwise.
More...
 
void Dump (Standard_OStream &astream) const
 Useful for debugging.
More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual void ShallowDump (Standard_OStream &) const
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Detailed Description

This class creates a dictionary of materials.

Constructor & Destructor Documentation

Materials_MaterialsDictionary::Materials_MaterialsDictionary ( )

Returns a MaterialsDictionary object which contains
the sequence of all the materials the user wants to
consider.

Member Function Documentation

void Materials_MaterialsDictionary::Dump ( Standard_OStream astream) const

Useful for debugging.

Standard_Boolean Materials_MaterialsDictionary::ExistMaterial ( const Standard_CString  aName) const

True if the materialofname aName exists ...

Handle_Materials_Material Materials_MaterialsDictionary::Material ( const Standard_CString  amaterial) const

Retrieves from the dictionary the object material with
<amaterial> as name. If <amaterial> does not exist in
the dictionary an exeption is raised.

Handle_Materials_Material Materials_MaterialsDictionary::Material ( const Standard_Integer  anindex) const

This method used with the previous one, allow the
exploration of all the dictionary. It returns a
Material instance.

Standard_Integer Materials_MaterialsDictionary::NumberOfMaterials ( ) const

Returns the number of materials previously stored in
the dictionary.

Standard_Boolean Materials_MaterialsDictionary::UpToDate ( ) const

Returns true if there has been no modification of the
file Materials.dat since the creation of the dictionary
object, false otherwise.


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