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

This class defines a typemap entry.
A typemap entry is an association between
a LineStyle object and an index in the typemap.
More...

#include <Aspect_TypeMapEntry.hxx>

Public Member Functions

 Aspect_TypeMapEntry ()
 Creates an unallocated typemap entry
More...
 
 Aspect_TypeMapEntry (const Standard_Integer index, const Aspect_LineStyle &style)
 Creates an allocated typemap entry
More...
 
 Aspect_TypeMapEntry (const Aspect_TypeMapEntry &entry)
 
Creates an allocated typemap entry. <br>

Warning: Raises error if the typemap entry <entry>
is unallocated.
More...

 
void SetValue (const Standard_Integer index, const Aspect_LineStyle &style)
 Sets typemap entry value and allocates it.
More...
 
void SetValue (const Aspect_TypeMapEntry &entry)
 Sets typemap entry value and allocates it.
More...
 
void operator= (const Aspect_TypeMapEntry &entry)
 
void SetType (const Aspect_LineStyle &Style)
 Sets the line style of typemap entry.
More...
 
const Aspect_LineStyleType () const
 
void SetIndex (const Standard_Integer index)
 Sets index value of a typemap entry.
More...
 
Standard_Integer Index () const
 
Returns index value of a typemap entry. <br>

Warning: Raises error if the typemap entry is unallocated .
More...

 
void Free ()
 Unallocates the typemap entry.
More...
 
Standard_Boolean IsAllocated () const
 
Returns True if the typemap entry is allocated. <br>

Warning: A typemap entry is allocated when the type and
the index is defined.
More...

 
void Dump () const
 

Detailed Description

This class defines a typemap entry.
A typemap entry is an association between
a LineStyle object and an index in the typemap.

Constructor & Destructor Documentation

Aspect_TypeMapEntry::Aspect_TypeMapEntry ( )

Creates an unallocated typemap entry

Aspect_TypeMapEntry::Aspect_TypeMapEntry ( const Standard_Integer  index,
const Aspect_LineStyle style 
)

Creates an allocated typemap entry

Aspect_TypeMapEntry::Aspect_TypeMapEntry ( const Aspect_TypeMapEntry entry)

Creates an allocated typemap entry. <br>

Warning: Raises error if the typemap entry <entry>
is unallocated.

Member Function Documentation

void Aspect_TypeMapEntry::Dump ( ) const
void Aspect_TypeMapEntry::Free ( )

Unallocates the typemap entry.

Standard_Integer Aspect_TypeMapEntry::Index ( ) const

Returns index value of a typemap entry. <br>

Warning: Raises error if the typemap entry is unallocated .

Standard_Boolean Aspect_TypeMapEntry::IsAllocated ( ) const

Returns True if the typemap entry is allocated. <br>

Warning: A typemap entry is allocated when the type and
the index is defined.

void Aspect_TypeMapEntry::operator= ( const Aspect_TypeMapEntry entry)
inline
void Aspect_TypeMapEntry::SetIndex ( const Standard_Integer  index)

Sets index value of a typemap entry.

void Aspect_TypeMapEntry::SetType ( const Aspect_LineStyle Style)

Sets the line style of typemap entry.

void Aspect_TypeMapEntry::SetValue ( const Standard_Integer  index,
const Aspect_LineStyle style 
)

Sets typemap entry value and allocates it.

void Aspect_TypeMapEntry::SetValue ( const Aspect_TypeMapEntry entry)

Sets typemap entry value and allocates it.

const Aspect_LineStyle& Aspect_TypeMapEntry::Type ( ) const

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