This class defines a markmap entrys.
A markmap entry is an association between
a MarkerStyle object and an index in the markmap.
More...

#include <Aspect_MarkMapEntry.hxx>

Public Member Functions
	Aspect_MarkMapEntry ()
	Creates an unallocated markmap entry More...

	Aspect_MarkMapEntry (const Standard_Integer index, const Aspect_MarkerStyle &style)
	Creates an allocated markmap entry More...

	Aspect_MarkMapEntry (const Aspect_MarkMapEntry &entry)
	Creates an allocated markmap entry. <br> Warning: Raises error if the markmap entry <entry> is unallocated. More...

void	SetValue (const Standard_Integer index, const Aspect_MarkerStyle &style)
	Sets markmap entry value and allocates it. More...

void	SetValue (const Aspect_MarkMapEntry &entry)
	Sets markmap entry value and allocates it. More...

void	operator= (const Aspect_MarkMapEntry &entry)

void	SetStyle (const Aspect_MarkerStyle &Style)
	Sets the marker style of markmap entry. More...

const Aspect_MarkerStyle &	Style () const

void	SetIndex (const Standard_Integer index)
	Sets index value of a markmap entry. More...

Standard_Integer	Index () const
	Returns index value of a markmap entry. <br> Warning: Raises error if the markmap entry is unallocated . More...

void	Free ()
	Unallocates the markmap entry. More...

Standard_Boolean	IsAllocated () const
	Returns True if the markmap entry is allocated. <br> Warning: A markmap entry is allocated when the marker and the index is defined. More...

void	Dump () const

Detailed Description

This class defines a markmap entrys.
A markmap entry is an association between
a MarkerStyle object and an index in the markmap.

Constructor & Destructor Documentation

Aspect_MarkMapEntry::Aspect_MarkMapEntry ( )

Creates an unallocated markmap entry

Aspect_MarkMapEntry::Aspect_MarkMapEntry	(	const Standard_Integer	index,
		const Aspect_MarkerStyle &	style
	)

Creates an allocated markmap entry

Aspect_MarkMapEntry::Aspect_MarkMapEntry ( const Aspect_MarkMapEntry & entry )

Creates an allocated markmap entry. <br>

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

void Aspect_MarkMapEntry::Dump ( ) const

void Aspect_MarkMapEntry::Free ( )

Unallocates the markmap entry.

Standard_Integer Aspect_MarkMapEntry::Index ( ) const

Returns index value of a markmap entry. <br>

Warning: Raises error if the markmap entry is unallocated .

Standard_Boolean Aspect_MarkMapEntry::IsAllocated ( ) const

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

Warning: A markmap entry is allocated when the marker and
the index is defined.

void Aspect_MarkMapEntry::operator= ( const Aspect_MarkMapEntry & entry )

inline

void Aspect_MarkMapEntry::SetIndex ( const Standard_Integer index )

Sets index value of a markmap entry.

void Aspect_MarkMapEntry::SetStyle ( const Aspect_MarkerStyle & Style )

Sets the marker style of markmap entry.

void Aspect_MarkMapEntry::SetValue	(	const Standard_Integer	index,
		const Aspect_MarkerStyle &	style
	)

Sets markmap entry value and allocates it.

void Aspect_MarkMapEntry::SetValue ( const Aspect_MarkMapEntry & entry )

Sets markmap entry value and allocates it.

const Aspect_MarkerStyle& Aspect_MarkMapEntry::Style ( ) const

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