#include <GA_BreakpointGroup.h>

Inheritance diagram for GA_BreakpointGroup:

Classes
class	base_iterator

class	Entry

Public Types
typedef base_iterator < GA_Breakpoint >	iterator

typedef base_iterator< const GA_Breakpoint >	const_iterator

Public Member Functions
	GA_BreakpointGroup (const GA_Detail &gdp, const char *name="")

	~GA_BreakpointGroup () override

const GA_Detail &	getDetail () const override
	Return the owning detail. More...

int64	getMemoryUsage (bool inclusive) const override
	Report memory usage. More...

void	countMemory (UT_MemoryCounter &counter, bool inclusive) const override

Entry *	find (const GA_Breakpoint &it) const

bool	contains (const GA_Breakpoint &it) const

bool	add (const GA_Breakpoint &it)

bool	toggle (const GA_Breakpoint &it)

bool	removeEntry (Entry *it)

bool	remove (const GA_Breakpoint &it)

UT_LinkList &	list ()

const UT_LinkList &	list () const

GA_Size	entries () const override
	Query the number of breakpoints from primary primitives in the group. More...

bool	isEmpty () const

GA_Size	entriesMix () const

virtual bool	isEmptyMix () const
	Query whether the group does not contain any breakpoints. More...

bool	isMixed () const override
	Query if we contain any breakpoints from secondary primitives. More...

bool	isOrdered () const override

void	clear () override

void	addAll () override

bool	jsonSaveData (UT_JSONWriter &w, const GA_SaveMap &map) const override

bool	jsonLoadData (UT_JSONParser &w, const GA_LoadMap &map) override
	Load breakpoint group from a JSON stream. More...

GA_BreakpointGroup &	operator\|= (const GA_BreakpointGroup &input_group)

GA_BreakpointGroup &	operator&= (const GA_BreakpointGroup &input_group)

GA_BreakpointGroup &	operator-= (const GA_BreakpointGroup &input_group)

GA_BreakpointGroup &	operator+= (const GA_BreakpointGroup &input_group)

GA_BreakpointGroup &	operator^= (const GA_BreakpointGroup &input_group)

GA_BreakpointGroup &	operator= (const GA_BreakpointGroup &input_group)

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

Public Member Functions inherited from GA_Group
virtual	~GA_Group ()

const UT_StringHolder &	getName () const

bool	isInternal () const

bool	getInternal () const

void	setInternal (bool on_off)

bool	isDetached () const

GA_GroupType	classType () const

GA_GroupMaskType	classMaskType () const

bool	isElementGroup () const

SYS_FORCE_INLINE bool	isEmpty () const

virtual bool	combine (const GA_Group *input_group)

void	clearEntries ()

virtual bool	stat (UT_WorkBuffer &info, uint level) const

virtual bool	jsonShouldSave (const GA_SaveMap &map) const

bool	jsonSaveDefinition (UT_JSONWriter &w, const char *type) const

void	dump (std::ostream &os)
	A convenience function to do a JSON dump of the group contents. More...

Additional Inherited Members
Static Public Member Functions inherited from GA_Group
static const char *	groupType (GA_GroupType type)

static GA_GroupType	groupType (const char *type)

static bool	jsonLoadDefinition (UT_JSONParser &p, UT_WorkBuffer &type, UT_WorkBuffer &name, bool &internal)
	Load the GA_Group-Definition. More...

Protected Member Functions inherited from GA_Group
	GA_Group (const UT_StringHolder &name, bool internal, GA_GroupType type, bool detached)

virtual bool	setName (const UT_StringHolder &n)

Detailed Description

Definition at line 29 of file GA_BreakpointGroup.h.

Member Typedef Documentation

typedef base_iterator<const GA_Breakpoint> GA_BreakpointGroup::const_iterator

Definition at line 199 of file GA_BreakpointGroup.h.

typedef base_iterator<GA_Breakpoint> GA_BreakpointGroup::iterator

Definition at line 198 of file GA_BreakpointGroup.h.

Constructor & Destructor Documentation

GA_BreakpointGroup::GA_BreakpointGroup	(	const GA_Detail &	gdp,
		const char *	name = `""`
	)

GA_BreakpointGroup::~GA_BreakpointGroup ( )

override

Member Function Documentation

bool GA_BreakpointGroup::add ( const GA_Breakpoint & it )

void GA_BreakpointGroup::addAll ( )

overridevirtual

Implements GA_Group.

iterator GA_BreakpointGroup::begin ( void )

inline

Definition at line 201 of file GA_BreakpointGroup.h.

const_iterator GA_BreakpointGroup::begin ( void ) const

inline

Definition at line 203 of file GA_BreakpointGroup.h.

void GA_BreakpointGroup::clear ( )

overridevirtual

Implements GA_Group.

bool GA_BreakpointGroup::contains ( const GA_Breakpoint & it ) const

void GA_BreakpointGroup::countMemory	(	UT_MemoryCounter &	counter,
		bool	inclusive
	)		const

overridevirtual

Count memory usage using a UT_MemoryCounter in order to count shared memory correctly. If inclusive is true, the size of this object is counted, else only memory owned by this object is counted. If this is pointed to by the calling object, inclusive should be true. If this is contained in the calling object, inclusive should be false. (Its memory was already counted in the size of the calling object.)

Implements GA_Group.

iterator GA_BreakpointGroup::end ( void )

inline

Definition at line 202 of file GA_BreakpointGroup.h.

const_iterator GA_BreakpointGroup::end ( void ) const

inline

Definition at line 204 of file GA_BreakpointGroup.h.

GA_Size GA_BreakpointGroup::entries ( ) const

inlineoverridevirtual

Query the number of breakpoints from primary primitives in the group.

Implements GA_Group.

Definition at line 76 of file GA_BreakpointGroup.h.

GA_Size GA_BreakpointGroup::entriesMix ( ) const

inline

Query the total number of breakpoints (from both primary and secondary primitives) in the group.

Definition at line 85 of file GA_BreakpointGroup.h.

Entry* GA_BreakpointGroup::find ( const GA_Breakpoint & it ) const

const GA_Detail& GA_BreakpointGroup::getDetail ( ) const

inlineoverridevirtual

Return the owning detail.

Implements GA_Group.

Definition at line 37 of file GA_BreakpointGroup.h.

int64 GA_BreakpointGroup::getMemoryUsage ( bool inclusive ) const

overridevirtual

Report memory usage.

Implements GA_Group.

bool GA_BreakpointGroup::isEmpty ( ) const

inline

Query whether the group does not contain any breakpoints from primary primitives.

Definition at line 80 of file GA_BreakpointGroup.h.

virtual bool GA_BreakpointGroup::isEmptyMix ( ) const

inlinevirtual

Query whether the group does not contain any breakpoints.

Definition at line 87 of file GA_BreakpointGroup.h.

bool GA_BreakpointGroup::isMixed ( ) const

inlineoverridevirtual

Query if we contain any breakpoints from secondary primitives.

Implements GA_Group.

Definition at line 90 of file GA_BreakpointGroup.h.

bool GA_BreakpointGroup::isOrdered ( ) const

inlineoverridevirtual

Implements GA_Group.

Definition at line 92 of file GA_BreakpointGroup.h.

bool GA_BreakpointGroup::jsonLoadData	(	UT_JSONParser &	w,
		const GA_LoadMap &	map
	)

overridevirtual

Load breakpoint group from a JSON stream.

Implements GA_Group.

bool GA_BreakpointGroup::jsonSaveData	(	UT_JSONWriter &	w,
		const GA_SaveMap &	map
	)		const

overridevirtual

Save data to a JSON stream.

JSON Schema: GA_BreakpointGroup

{
    "name"          : "GA_BreakpointGroup",
    "description"   : "A list of breakpoints",
    "type"          : "orderedmap",
    "properties": {
        "breakpoints": {
            "type"   : "array",
            "items"  : { "$ref", "GA_Breakpoint" },
            "description" : "Array of breakpoints in the group",
        }
    },
}

See Also: JSON_FileFormat, GA_Group

Implements GA_Group.

UT_LinkList& GA_BreakpointGroup::list ( )

inline

Definition at line 72 of file GA_BreakpointGroup.h.

const UT_LinkList& GA_BreakpointGroup::list ( ) const

inline

Definition at line 73 of file GA_BreakpointGroup.h.

GA_BreakpointGroup& GA_BreakpointGroup::operator&= ( const GA_BreakpointGroup & input_group )

GA_BreakpointGroup& GA_BreakpointGroup::operator+= ( const GA_BreakpointGroup & input_group )

GA_BreakpointGroup& GA_BreakpointGroup::operator-= ( const GA_BreakpointGroup & input_group )

GA_BreakpointGroup& GA_BreakpointGroup::operator= ( const GA_BreakpointGroup & input_group )

GA_BreakpointGroup& GA_BreakpointGroup::operator^= ( const GA_BreakpointGroup & input_group )

GA_BreakpointGroup& GA_BreakpointGroup::operator|= ( const GA_BreakpointGroup & input_group )

Iterator to iterate over all breakpoints in the group. It is safe to call advance() after deleting the current entry.

bool GA_BreakpointGroup::remove ( const GA_Breakpoint & it )

bool GA_BreakpointGroup::removeEntry ( Entry * it )

bool GA_BreakpointGroup::toggle ( const GA_Breakpoint & it )

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

GA/GA_BreakpointGroup.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

JSON Schema: GA_BreakpointGroup