ClassDefAliasImpl Class Reference

Inheritance diagram for ClassDefAliasImpl:

Collaboration diagram for ClassDefAliasImpl:

Public Member Functions
	ClassDefAliasImpl (const Definition *newScope, const ClassDef *cd)
	~ClassDefAliasImpl () override
DefType	definitionType () const override
const ClassDef *	getCdAlias () const
std::unique_ptr< ClassDef >	deepCopy (const DString &name) const override
void	moveTo (Definition *) override
CodeSymbolType	codeSymbolType () const override
DString	getOutputFileBase () const override
DString	getInstanceOutputFileBase () const override
DString	getSourceFileBase () const override
DString	getReference () const override
bool	isReference () const override
bool	isLocal () const override
	Returns true if this is a local class definition, see EXTRACT_LOCAL_CLASSES.
ClassLinkedRefMap	getClasses () const override
	returns the classes nested into this class
bool	hasDocumentation () const override
bool	hasDetailedDescription () const override
	returns true if this class has a non-empty detailed description
DString	collaborationGraphFileName () const override
	returns the file name to use for the collaboration graph
DString	inheritanceGraphFileName () const override
	returns the file name to use for the inheritance graph
DString	displayName (bool includeScope=true) const override
CompoundType	compoundType () const override
	Returns the type of compound this is, i.e. class/struct/union/...
DString	compoundTypeString () const override
	Returns the type of compound as a string.
const BaseClassList &	baseClasses () const override
	Returns the list of base classes from which this class directly inherits.
const BaseClassList &	subClasses () const override
	Returns the list of sub classes that directly derive from this class.
const MemberNameInfoLinkedMap &	memberNameInfoLinkedMap () const override
	Returns a dictionary of all members.
Protection	protection () const override
	Return the protection level (Public,Protected,Private) in which this compound was found.
bool	isLinkableInProject () const override
bool	isLinkable () const override
bool	isVisibleInHierarchy () const override
	the class is visible in a class diagram, or class hierarchy
bool	visibleInParentsDeclList () const override
	show this class in the declaration section of its parent?
const ArgumentList &	templateArguments () const override
	Returns the template arguments of this class.
FileDef *	getFileDef () const override
	Returns the file in which this compound's definition can be found.
ModuleDef *	getModuleDef () const override
	Returns the C++20 module in which this compound's definition can be found.
const MemberDef *	getMemberByName (const DString &s) const override
	Returns the member with the given name.
int	isBaseClass (const ClassDef *bcd, bool followInstances, const DString &templSpec) const override
	Returns true iff bcd is a direct or indirect base class of this class.
bool	isSubClass (ClassDef *bcd, int level=0) const override
	Returns true iff bcd is a direct or indirect sub class of this class.
bool	isAccessibleMember (const MemberDef *md) const override
	returns true iff md is a member of this class or of the the public/protected members of a base class
const TemplateInstanceList &	getTemplateInstances () const override
	Returns a sorted dictionary with all template instances found for this template class.
const ClassDef *	templateMaster () const override
	Returns the template master of which this class is an instance.
bool	isTemplate () const override
	Returns true if this class is a template.
const IncludeInfo *	includeInfo () const override
const UsesClassList &	usedImplementationClasses () const override
const UsesClassList &	usedByImplementationClasses () const override
const ConstraintClassList &	templateTypeConstraints () const override
bool	isTemplateArgument () const override
const Definition *	findInnerCompound (const DString &name) const override
ArgumentLists	getTemplateParameterLists () const override
	Returns the template parameter lists that form the template declaration of this class.
DString	qualifiedNameWithTemplateParameters (const ArgumentLists *actualParams=nullptr, uint32_t *actualParamIndex=nullptr) const override
bool	isAbstract () const override
	Returns true if there is at least one pure virtual member in this class.
bool	isObjectiveC () const override
	Returns true if this class is implemented in Objective-C.
bool	isFortran () const override
	Returns true if this class is implemented in Fortran.
bool	isCSharp () const override
	Returns true if this class is implemented in C#.
bool	isFinal () const override
	Returns true if this class is marked as final.
bool	isSealed () const override
	Returns true if this class is marked as sealed.
bool	isPublished () const override
	Returns true if this class is marked as published.
bool	isExtension () const override
	Returns true if this class represents an Objective-C 2.0 extension (nameless category).
bool	isForwardDeclared () const override
	Returns true if this class represents a forward declaration of a template class.
bool	isInterface () const override
	Returns true if this class represents an interface.
ClassDef *	categoryOf () const override
	Returns the class of which this is a category (Objective-C only).
DString	className () const override
	Returns the name of the class including outer classes, but not including namespaces.
MemberList *	getMemberList (MemberListType lt) const override
	Returns the members in the list identified by lt.
const MemberLists &	getMemberLists () const override
	Returns the list containing the list of members sorted per type.
const MemberGroupList &	getMemberGroups () const override
	Returns the member groups defined for this class.
const TemplateNameMap &	getTemplateBaseClassNames () const override
bool	isUsedOnly () const override
DString	anchor () const override
bool	isEmbeddedInOuterScope () const override
bool	isSimple () const override
const ClassDef *	taglessParent () const override
bool	hasNamedVariable () const override
const MemberDef *	isSmartPointer () const override
bool	isJavaEnum () const override
DString	title () const override
DString	generatedFromFiles () const override
const FileList &	usedFiles () const override
const ArgumentList &	typeConstraints () const override
const ExampleList &	getExamples () const override
bool	hasExamples () const override
DString	getMemberListFileName () const override
bool	subGrouping () const override
bool	isSliceLocal () const override
bool	hasNonReferenceSuperClass () const override
DString	requiresClause () const override
StringVector	getQualifiers () const override
bool	containsOverload (const MemberDef *md) const override
int	countMembersIncludingGrouped (MemberListType lt, const ClassDef *inheritedFrom, bool additional) const override
int	countMemberDeclarations (MemberListType lt, const ClassDef *inheritedFrom, MemberListType lt2, bool invert, bool showAlways, ClassDefSet &visitedClasses) const override
void	writeDeclarationLink (OutputList &ol, bool &found, const DString &header, bool localNames) const override
bool	isImplicitTemplateInstance () const override
void	writeDocumentation (OutputList &ol) const override
void	writeDocumentationForInnerClasses (OutputList &ol) const override
void	writeMemberPages (OutputList &ol) const override
void	writeMemberList (OutputList &ol) const override
void	writeDeclaration (OutputList &ol, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const DString &inheritId) const override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void	writeSummaryLinks (OutputList &ol) const override
void	writePageNavigation (OutputList &ol) const override
void	writeInlineDocumentation (OutputList &ol) const override
void	writeTagFile (TextStream &ol) const override
void	writeMemberDeclarations (OutputList &ol, ClassDefSet &visitedClasses, MemberListType lt, const DString &title, const DString &subTitle=DString(), bool showInline=false, const ClassDef *inheritedFrom=nullptr, MemberListType lt2=MemberListType::Invalid(), bool invert=false, bool showAlways=false) const override
void	addGroupedInheritedMembers (OutputList &ol, MemberListType lt, const ClassDef *inheritedFrom, const DString &inheritId) const override
void	updateBaseClasses (const BaseClassList &) override
	Update the list of base classes to the one passed.
void	updateSubClasses (const BaseClassList &) override
	Update the list of sub classes to the one passed.
Public Member Functions inherited from DefinitionAliasMixin< ClassDef >
	DefinitionAliasMixin (const Definition *scope, const Definition *alias)
	~DefinitionAliasMixin () override=default
void	init ()
void	deinit ()
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
const DString &	localName () const override
DString	qualifiedName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
DString	documentation () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescription (bool abbreviate=false) const override
DString	briefDescriptionAsTooltip () const override
int	briefLine () const override
DString	inbodyDocumentation () const override
DString	inbodyFile () const override
int	inbodyLine () const override
DString	briefFile () const override
DString	getDefFileName () const override
DString	getDefFileExtension () const override
int	getDefLine () const override
size_t	getDefColumn () const override
bool	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	getReference () const override
bool	isReference () const override
DString	externalReference (const DString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const RequirementRefs &	requirementReferences () const override
const Definition *	findInnerCompound (const DString &name) const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
DString	id () const override
const SectionRefs &	getSectionRefs () const override
DString	navigationPathAsString () const override
DString	pathFragment () const override

Additional Inherited Members
Public Types inherited from ClassDef
enum	CompoundType {   Class , Struct , Union , Interface ,   Protocol , Category , Exception , Service ,   Singleton }
	The various compound types. More...
Public Types inherited from Definition
enum	DefType {   TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,   TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,   TypeDir = 8 , TypeConcept = 9 }
Protected Member Functions inherited from DefinitionAliasMixin< ClassDef >
const Definition *	getAlias () const
const Definition *	getScope () const

Detailed Description

Definition at line 592 of file classdef.cpp.

Constructor & Destructor Documentation

ClassDefAliasImpl()

ClassDefAliasImpl::ClassDefAliasImpl ( const Definition * newScope, const ClassDef * cd )

inline

Definition at line 595 of file classdef.cpp.

      : DefinitionAliasMixin(newScope,cd) { init(); }

References DefinitionAliasMixin< ClassDef >::DefinitionAliasMixin(), and DefinitionAliasMixin< ClassDef >::init().

~ClassDefAliasImpl()

ClassDefAliasImpl::~ClassDefAliasImpl ( )

inlineoverride

Definition at line 597 of file classdef.cpp.

{ deinit(); }

References DefinitionAliasMixin< ClassDef >::deinit().

Member Function Documentation

addGroupedInheritedMembers()

void ClassDefAliasImpl::addGroupedInheritedMembers ( OutputList & ol, MemberListType lt, const ClassDef * inheritedFrom, const DString & inheritId ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 805 of file classdef.cpp.

    { getCdAlias()->addGroupedInheritedMembers(ol,lt,inheritedFrom,inheritId); }

References ClassDef::addGroupedInheritedMembers(), and getCdAlias().

anchor()

DString ClassDefAliasImpl::anchor ( ) const

inlineoverridevirtual

Returns the anchor within a page where this item can be found

Implements Definition.

Definition at line 725 of file classdef.cpp.

    { return getCdAlias()->anchor(); }

References Definition::anchor(), and getCdAlias().

baseClasses()

const BaseClassList & ClassDefAliasImpl::baseClasses ( ) const

inlineoverridevirtual

Returns the list of base classes from which this class directly inherits.

Implements ClassDef.

Definition at line 638 of file classdef.cpp.

    { return getCdAlias()->baseClasses(); }

References ClassDef::baseClasses(), and getCdAlias().

categoryOf()

ClassDef * ClassDefAliasImpl::categoryOf ( ) const

inlineoverridevirtual

Returns the class of which this is a category (Objective-C only).

Implements ClassDef.

Definition at line 711 of file classdef.cpp.

    { return getCdAlias()->categoryOf(); }

References ClassDef::categoryOf(), and getCdAlias().

className()

DString ClassDefAliasImpl::className ( ) const

inlineoverridevirtual

Returns the name of the class including outer classes, but not including namespaces.

Implements ClassDef.

Definition at line 713 of file classdef.cpp.

    { return getCdAlias()->className(); }

References ClassDef::className(), and getCdAlias().

codeSymbolType()

CodeSymbolType ClassDefAliasImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 608 of file classdef.cpp.

    { return getCdAlias()->codeSymbolType(); }

References Definition::codeSymbolType(), and getCdAlias().

collaborationGraphFileName()

DString ClassDefAliasImpl::collaborationGraphFileName ( ) const

inlineoverridevirtual

returns the file name to use for the collaboration graph

Implements ClassDef.

Definition at line 628 of file classdef.cpp.

    { return getCdAlias()->collaborationGraphFileName(); }

References ClassDef::collaborationGraphFileName(), and getCdAlias().

compoundType()

CompoundType ClassDefAliasImpl::compoundType ( ) const

inlineoverridevirtual

Returns the type of compound this is, i.e. class/struct/union/...

Implements ClassDef.

Definition at line 634 of file classdef.cpp.

    { return getCdAlias()->compoundType(); }

References ClassDef::compoundType(), and getCdAlias().

compoundTypeString()

DString ClassDefAliasImpl::compoundTypeString ( ) const

inlineoverridevirtual

Returns the type of compound as a string.

Implements ClassDef.

Definition at line 636 of file classdef.cpp.

    { return getCdAlias()->compoundTypeString(); }

References ClassDef::compoundTypeString(), and getCdAlias().

containsOverload()

bool ClassDefAliasImpl::containsOverload ( const MemberDef * md ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 763 of file classdef.cpp.

    { return getCdAlias()->containsOverload(md); }

References ClassDef::containsOverload(), and getCdAlias().

countMemberDeclarations()

int ClassDefAliasImpl::countMemberDeclarations ( MemberListType lt, const ClassDef * inheritedFrom, MemberListType lt2, bool invert, bool showAlways, ClassDefSet & visitedClasses ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 768 of file classdef.cpp.

    { return getCdAlias()->countMemberDeclarations(lt,inheritedFrom,lt2,invert,showAlways,visitedClasses); }

References ClassDef::countMemberDeclarations(), and getCdAlias().

countMembersIncludingGrouped()

int ClassDefAliasImpl::countMembersIncludingGrouped ( MemberListType lt, const ClassDef * inheritedFrom, bool additional ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 766 of file classdef.cpp.

    { return getCdAlias()->countMembersIncludingGrouped(lt,inheritedFrom,additional); }

References ClassDef::countMembersIncludingGrouped(), and getCdAlias().

deepCopy()

std::unique_ptr< ClassDef > ClassDefAliasImpl::deepCopy ( const DString & name ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 603 of file classdef.cpp.

                                                                          {
      return createClassDefAlias(getScope(),getCdAlias());
    }

References createClassDefAlias(), getCdAlias(), DefinitionAliasMixin< ClassDef >::getScope(), and DefinitionAliasMixin< ClassDef >::name().

definitionType()

DefType ClassDefAliasImpl::definitionType ( ) const

inlineoverridevirtual

Use this for dynamic inspection of the type of the derived class

Implements Definition.

Definition at line 600 of file classdef.cpp.

{ return TypeClass; }

References definitionType(), and Definition::TypeClass.

Referenced by definitionType().

displayName()

DString ClassDefAliasImpl::displayName ( bool includeScope = true ) const

inlineoverridevirtual

Returns the name of the definition as it appears in the output

Implements Definition.

Definition at line 632 of file classdef.cpp.

    { return makeDisplayName(this,includeScope); }

References makeDisplayName().

findInnerCompound()

const Definition * ClassDefAliasImpl::findInnerCompound ( const DString & name ) const

inlineoverridevirtual

Implements Definition.

Definition at line 684 of file classdef.cpp.

    { return getCdAlias()->findInnerCompound(name); }

References Definition::findInnerCompound(), getCdAlias(), and DefinitionAliasMixin< ClassDef >::name().

generatedFromFiles()

DString ClassDefAliasImpl::generatedFromFiles ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 741 of file classdef.cpp.

    { return getCdAlias()->generatedFromFiles(); }

References ClassDef::generatedFromFiles(), and getCdAlias().

getCdAlias()

const ClassDef * ClassDefAliasImpl::getCdAlias ( ) const

inline

Definition at line 602 of file classdef.cpp.

{ return toClassDef(getAlias()); }

References DefinitionAliasMixin< ClassDef >::getAlias(), and toClassDef().

Referenced by addGroupedInheritedMembers(), anchor(), baseClasses(), categoryOf(), className(), codeSymbolType(), collaborationGraphFileName(), compoundType(), compoundTypeString(), containsOverload(), countMemberDeclarations(), countMembersIncludingGrouped(), deepCopy(), findInnerCompound(), generatedFromFiles(), getClasses(), getExamples(), getFileDef(), getInstanceOutputFileBase(), getMemberByName(), getMemberGroups(), getMemberList(), getMemberListFileName(), getMemberLists(), getModuleDef(), getOutputFileBase(), getQualifiers(), getReference(), getSourceFileBase(), getTemplateBaseClassNames(), getTemplateInstances(), getTemplateParameterLists(), hasDetailedDescription(), hasDocumentation(), hasExamples(), hasNamedVariable(), hasNonReferenceSuperClass(), includeInfo(), inheritanceGraphFileName(), isAbstract(), isAccessibleMember(), isBaseClass(), isCSharp(), isEmbeddedInOuterScope(), isExtension(), isFinal(), isFortran(), isForwardDeclared(), isImplicitTemplateInstance(), isInterface(), isJavaEnum(), isLinkable(), isLinkableInProject(), isLocal(), isObjectiveC(), isPublished(), isReference(), isSealed(), isSimple(), isSliceLocal(), isSmartPointer(), isSubClass(), isTemplate(), isTemplateArgument(), isUsedOnly(), isVisibleInHierarchy(), memberNameInfoLinkedMap(), protection(), requiresClause(), subClasses(), subGrouping(), taglessParent(), templateArguments(), templateMaster(), templateTypeConstraints(), title(), typeConstraints(), usedByImplementationClasses(), usedFiles(), usedImplementationClasses(), visibleInParentsDeclList(), writeDeclaration(), writeDeclarationLink(), writeDocumentation(), writeDocumentationForInnerClasses(), writeInlineDocumentation(), writeMemberDeclarations(), writeMemberList(), writeMemberPages(), writePageNavigation(), writeQuickMemberLinks(), writeSummaryLinks(), and writeTagFile().

getClasses()

ClassLinkedRefMap ClassDefAliasImpl::getClasses ( ) const

inlineoverridevirtual

returns the classes nested into this class

Implements ClassDef.

Definition at line 622 of file classdef.cpp.

    { return getCdAlias()->getClasses(); }

References getCdAlias(), and ClassDef::getClasses().

getExamples()

const ExampleList & ClassDefAliasImpl::getExamples ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 747 of file classdef.cpp.

    { return getCdAlias()->getExamples(); }

References getCdAlias(), and ClassDef::getExamples().

getFileDef()

FileDef * ClassDefAliasImpl::getFileDef ( ) const

inlineoverridevirtual

Returns the file in which this compound's definition can be found.

Should not return 0 (but it might be a good idea to check anyway).

Implements ClassDef.

Definition at line 656 of file classdef.cpp.

    { return getCdAlias()->getFileDef(); }

References getCdAlias(), and ClassDef::getFileDef().

getInstanceOutputFileBase()

DString ClassDefAliasImpl::getInstanceOutputFileBase ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 612 of file classdef.cpp.

    { return getCdAlias()->getInstanceOutputFileBase(); }

References getCdAlias(), and ClassDef::getInstanceOutputFileBase().

getMemberByName()

const MemberDef * ClassDefAliasImpl::getMemberByName ( const DString & s ) const

inlineoverridevirtual

Returns the member with the given name.

Implements ClassDef.

Definition at line 660 of file classdef.cpp.

    { return getCdAlias()->getMemberByName(s); }

References getCdAlias(), and ClassDef::getMemberByName().

getMemberGroups()

const MemberGroupList & ClassDefAliasImpl::getMemberGroups ( ) const

inlineoverridevirtual

Returns the member groups defined for this class.

Implements ClassDef.

Definition at line 719 of file classdef.cpp.

    { return getCdAlias()->getMemberGroups(); }

References getCdAlias(), and ClassDef::getMemberGroups().

getMemberList()

MemberList * ClassDefAliasImpl::getMemberList ( MemberListType lt ) const

inlineoverridevirtual

Returns the members in the list identified by lt.

Implements ClassDef.

Definition at line 715 of file classdef.cpp.

    { return getCdAlias()->getMemberList(lt); }

References getCdAlias(), and ClassDef::getMemberList().

getMemberListFileName()

DString ClassDefAliasImpl::getMemberListFileName ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 751 of file classdef.cpp.

    { return getCdAlias()->getMemberListFileName(); }

References getCdAlias(), and ClassDef::getMemberListFileName().

getMemberLists()

const MemberLists & ClassDefAliasImpl::getMemberLists ( ) const

inlineoverridevirtual

Returns the list containing the list of members sorted per type.

Implements ClassDef.

Definition at line 717 of file classdef.cpp.

    { return getCdAlias()->getMemberLists(); }

References getCdAlias(), and ClassDef::getMemberLists().

getModuleDef()

ModuleDef * ClassDefAliasImpl::getModuleDef ( ) const

inlineoverridevirtual

Returns the C++20 module in which this compound's definition can be found.

Implements ClassDef.

Definition at line 658 of file classdef.cpp.

    { return getCdAlias()->getModuleDef(); }

References getCdAlias(), and ClassDef::getModuleDef().

getOutputFileBase()

DString ClassDefAliasImpl::getOutputFileBase ( ) const

inlineoverridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements Definition.

Definition at line 610 of file classdef.cpp.

    { return getCdAlias()->getOutputFileBase(); }

References getCdAlias(), and Definition::getOutputFileBase().

getQualifiers()

StringVector ClassDefAliasImpl::getQualifiers ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 761 of file classdef.cpp.

    { return getCdAlias()->getQualifiers(); }

References getCdAlias(), and ClassDef::getQualifiers().

getReference()

DString ClassDefAliasImpl::getReference ( ) const

inlineoverridevirtual

If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict

Implements Definition.

Definition at line 616 of file classdef.cpp.

    { return getCdAlias()->getReference(); }

References getCdAlias(), and Definition::getReference().

getSourceFileBase()

DString ClassDefAliasImpl::getSourceFileBase ( ) const

inlineoverridevirtual

Returns the name of the source listing of this definition.

Implements Definition.

Definition at line 614 of file classdef.cpp.

    { return getCdAlias()->getSourceFileBase(); }

References getCdAlias(), and Definition::getSourceFileBase().

getTemplateBaseClassNames()

const TemplateNameMap & ClassDefAliasImpl::getTemplateBaseClassNames ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 721 of file classdef.cpp.

    { return getCdAlias()->getTemplateBaseClassNames(); }

References getCdAlias(), and ClassDef::getTemplateBaseClassNames().

getTemplateInstances()

const TemplateInstanceList & ClassDefAliasImpl::getTemplateInstances ( ) const

inlineoverridevirtual

Returns a sorted dictionary with all template instances found for this template class.

Returns 0 if not a template or no instances.

Implements ClassDef.

Definition at line 668 of file classdef.cpp.

    { return getCdAlias()->getTemplateInstances(); }

References getCdAlias(), and ClassDef::getTemplateInstances().

getTemplateParameterLists()

ArgumentLists ClassDefAliasImpl::getTemplateParameterLists ( ) const

inlineoverridevirtual

Returns the template parameter lists that form the template declaration of this class.

Example: template<class T> class TC {} = 0; will return a list with one ArgumentList containing one argument with type="class" and name="T".

Implements ClassDef.

Definition at line 686 of file classdef.cpp.

    { return getCdAlias()->getTemplateParameterLists(); }

References getCdAlias(), and ClassDef::getTemplateParameterLists().

hasDetailedDescription()

bool ClassDefAliasImpl::hasDetailedDescription ( ) const

inlineoverridevirtual

returns true if this class has a non-empty detailed description

Implements ClassDef.

Definition at line 626 of file classdef.cpp.

    { return getCdAlias()->hasDetailedDescription(); }

References getCdAlias(), and ClassDef::hasDetailedDescription().

hasDocumentation()

bool ClassDefAliasImpl::hasDocumentation ( ) const

inlineoverridevirtual

Returns true iff the definition is documented (which could be generated documentation)

See also

hasUserDocumentation()

Implements Definition.

Definition at line 624 of file classdef.cpp.

    { return getCdAlias()->hasDocumentation(); }

References getCdAlias(), and Definition::hasDocumentation().

hasExamples()

bool ClassDefAliasImpl::hasExamples ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 749 of file classdef.cpp.

    { return getCdAlias()->hasExamples(); }

References getCdAlias(), and ClassDef::hasExamples().

hasNamedVariable()

bool ClassDefAliasImpl::hasNamedVariable ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 733 of file classdef.cpp.

    { return getCdAlias()->hasNamedVariable(); }

References getCdAlias(), and ClassDef::hasNamedVariable().

hasNonReferenceSuperClass()

bool ClassDefAliasImpl::hasNonReferenceSuperClass ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 757 of file classdef.cpp.

    { return getCdAlias()->hasNonReferenceSuperClass(); }

References getCdAlias(), and ClassDef::hasNonReferenceSuperClass().

includeInfo()

const IncludeInfo * ClassDefAliasImpl::includeInfo ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 674 of file classdef.cpp.

    { return getCdAlias()->includeInfo(); }

References getCdAlias(), and ClassDef::includeInfo().

inheritanceGraphFileName()

DString ClassDefAliasImpl::inheritanceGraphFileName ( ) const

inlineoverridevirtual

returns the file name to use for the inheritance graph

Implements ClassDef.

Definition at line 630 of file classdef.cpp.

    { return getCdAlias()->inheritanceGraphFileName(); }

References getCdAlias(), and ClassDef::inheritanceGraphFileName().

isAbstract()

bool ClassDefAliasImpl::isAbstract ( ) const

inlineoverridevirtual

Returns true if there is at least one pure virtual member in this class.

Implements ClassDef.

Definition at line 691 of file classdef.cpp.

    { return getCdAlias()->isAbstract(); }

References getCdAlias(), and ClassDef::isAbstract().

isAccessibleMember()

bool ClassDefAliasImpl::isAccessibleMember ( const MemberDef * md ) const

inlineoverridevirtual

returns true iff md is a member of this class or of the the public/protected members of a base class

Implements ClassDef.

Definition at line 666 of file classdef.cpp.

    { return getCdAlias()->isAccessibleMember(md); }

References getCdAlias(), and ClassDef::isAccessibleMember().

isBaseClass()

int ClassDefAliasImpl::isBaseClass ( const ClassDef * bcd, bool followInstances, const DString & templSpec ) const

inlineoverridevirtual

Returns true iff bcd is a direct or indirect base class of this class.

This function will recursively traverse all branches of the inheritance tree.

Implements ClassDef.

Definition at line 662 of file classdef.cpp.

    { return getCdAlias()->isBaseClass(bcd,followInstances,templSpec); }

References getCdAlias(), and ClassDef::isBaseClass().

isCSharp()

bool ClassDefAliasImpl::isCSharp ( ) const

inlineoverridevirtual

Returns true if this class is implemented in C#.

Implements ClassDef.

Definition at line 697 of file classdef.cpp.

    { return getCdAlias()->isCSharp(); }

References getCdAlias(), and ClassDef::isCSharp().

isEmbeddedInOuterScope()

bool ClassDefAliasImpl::isEmbeddedInOuterScope ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 727 of file classdef.cpp.

    { return getCdAlias()->isEmbeddedInOuterScope(); }

References getCdAlias(), and ClassDef::isEmbeddedInOuterScope().

isExtension()

bool ClassDefAliasImpl::isExtension ( ) const

inlineoverridevirtual

Returns true if this class represents an Objective-C 2.0 extension (nameless category).

Implements ClassDef.

Definition at line 705 of file classdef.cpp.

    { return getCdAlias()->isExtension(); }

References getCdAlias(), and ClassDef::isExtension().

isFinal()

bool ClassDefAliasImpl::isFinal ( ) const

inlineoverridevirtual

Returns true if this class is marked as final.

Implements ClassDef.

Definition at line 699 of file classdef.cpp.

    { return getCdAlias()->isFinal(); }

References getCdAlias(), and ClassDef::isFinal().

isFortran()

bool ClassDefAliasImpl::isFortran ( ) const

inlineoverridevirtual

Returns true if this class is implemented in Fortran.

Implements ClassDef.

Definition at line 695 of file classdef.cpp.

    { return getCdAlias()->isFortran(); }

References getCdAlias(), and ClassDef::isFortran().

isForwardDeclared()

bool ClassDefAliasImpl::isForwardDeclared ( ) const

inlineoverridevirtual

Returns true if this class represents a forward declaration of a template class.

Implements ClassDef.

Definition at line 707 of file classdef.cpp.

    { return getCdAlias()->isForwardDeclared(); }

References getCdAlias(), and ClassDef::isForwardDeclared().

isImplicitTemplateInstance()

bool ClassDefAliasImpl::isImplicitTemplateInstance ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 775 of file classdef.cpp.

    { return getCdAlias()->isImplicitTemplateInstance(); }

References getCdAlias(), and ClassDef::isImplicitTemplateInstance().

isInterface()

bool ClassDefAliasImpl::isInterface ( ) const

inlineoverridevirtual

Returns true if this class represents an interface.

Implements ClassDef.

Definition at line 709 of file classdef.cpp.

    { return getCdAlias()->isInterface(); }

References getCdAlias(), and ClassDef::isInterface().

isJavaEnum()

bool ClassDefAliasImpl::isJavaEnum ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 737 of file classdef.cpp.

    { return getCdAlias()->isJavaEnum(); }

References getCdAlias(), and ClassDef::isJavaEnum().

isLinkable()

bool ClassDefAliasImpl::isLinkable ( ) const

inlineoverridevirtual

Returns true iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Definition at line 648 of file classdef.cpp.

    { return getCdAlias()->isLinkable(); }

References getCdAlias(), and Definition::isLinkable().

isLinkableInProject()

bool ClassDefAliasImpl::isLinkableInProject ( ) const

inlineoverridevirtual

Returns true iff it is possible to link to this item within this project.

Implements Definition.

Definition at line 646 of file classdef.cpp.

    { return getCdAlias()->isLinkableInProject(); }

References getCdAlias(), and Definition::isLinkableInProject().

isLocal()

bool ClassDefAliasImpl::isLocal ( ) const

inlineoverridevirtual

Returns true if this is a local class definition, see EXTRACT_LOCAL_CLASSES.

Implements ClassDef.

Definition at line 620 of file classdef.cpp.

    { return getCdAlias()->isLocal(); }

References getCdAlias(), and ClassDef::isLocal().

isObjectiveC()

bool ClassDefAliasImpl::isObjectiveC ( ) const

inlineoverridevirtual

Returns true if this class is implemented in Objective-C.

Implements ClassDef.

Definition at line 693 of file classdef.cpp.

    { return getCdAlias()->isObjectiveC(); }

References getCdAlias(), and ClassDef::isObjectiveC().

isPublished()

bool ClassDefAliasImpl::isPublished ( ) const

inlineoverridevirtual

Returns true if this class is marked as published.

Implements ClassDef.

Definition at line 703 of file classdef.cpp.

    { return getCdAlias()->isPublished(); }

References getCdAlias(), and ClassDef::isPublished().

isReference()

bool ClassDefAliasImpl::isReference ( ) const

inlineoverridevirtual

Returns true if this definition is imported via a tag file.

Implements Definition.

Definition at line 618 of file classdef.cpp.

    { return getCdAlias()->isReference(); }

References getCdAlias(), and Definition::isReference().

isSealed()

bool ClassDefAliasImpl::isSealed ( ) const

inlineoverridevirtual

Returns true if this class is marked as sealed.

Implements ClassDef.

Definition at line 701 of file classdef.cpp.

    { return getCdAlias()->isSealed(); }

References getCdAlias(), and ClassDef::isSealed().

isSimple()

bool ClassDefAliasImpl::isSimple ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 729 of file classdef.cpp.

    { return getCdAlias()->isSimple(); }

References getCdAlias(), and ClassDef::isSimple().

isSliceLocal()

bool ClassDefAliasImpl::isSliceLocal ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 755 of file classdef.cpp.

    { return getCdAlias()->isSliceLocal(); }

References getCdAlias(), and ClassDef::isSliceLocal().

isSmartPointer()

const MemberDef * ClassDefAliasImpl::isSmartPointer ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 735 of file classdef.cpp.

    { return getCdAlias()->isSmartPointer(); }

References getCdAlias(), and ClassDef::isSmartPointer().

isSubClass()

bool ClassDefAliasImpl::isSubClass ( ClassDef * bcd, int level = 0 ) const

inlineoverridevirtual

Returns true iff bcd is a direct or indirect sub class of this class.

Implements ClassDef.

Definition at line 664 of file classdef.cpp.

    { return getCdAlias()->isSubClass(bcd,level); }

References getCdAlias(), and ClassDef::isSubClass().

isTemplate()

bool ClassDefAliasImpl::isTemplate ( ) const

inlineoverridevirtual

Returns true if this class is a template.

Implements ClassDef.

Definition at line 672 of file classdef.cpp.

    { return getCdAlias()->isTemplate(); }

References getCdAlias(), and ClassDef::isTemplate().

isTemplateArgument()

bool ClassDefAliasImpl::isTemplateArgument ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 682 of file classdef.cpp.

    { return getCdAlias()->isTemplateArgument(); }

References getCdAlias(), and ClassDef::isTemplateArgument().

isUsedOnly()

bool ClassDefAliasImpl::isUsedOnly ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 723 of file classdef.cpp.

    { return getCdAlias()->isUsedOnly(); }

References getCdAlias(), and ClassDef::isUsedOnly().

isVisibleInHierarchy()

bool ClassDefAliasImpl::isVisibleInHierarchy ( ) const

inlineoverridevirtual

the class is visible in a class diagram, or class hierarchy

Implements ClassDef.

Definition at line 650 of file classdef.cpp.

    { return getCdAlias()->isVisibleInHierarchy(); }

References getCdAlias(), and ClassDef::isVisibleInHierarchy().

memberNameInfoLinkedMap()

const MemberNameInfoLinkedMap & ClassDefAliasImpl::memberNameInfoLinkedMap ( ) const

inlineoverridevirtual

Returns a dictionary of all members.

This includes any inherited members. Members are sorted alphabetically.

Implements ClassDef.

Definition at line 642 of file classdef.cpp.

    { return getCdAlias()->memberNameInfoLinkedMap(); }

References getCdAlias(), and ClassDef::memberNameInfoLinkedMap().

moveTo()

void ClassDefAliasImpl::moveTo ( Definition * )

inlineoverridevirtual

Implements ClassDef.

Definition at line 606 of file classdef.cpp.

{}

protection()

Protection ClassDefAliasImpl::protection ( ) const

inlineoverridevirtual

Return the protection level (Public,Protected,Private) in which this compound was found.

Implements ClassDef.

Definition at line 644 of file classdef.cpp.

    { return getCdAlias()->protection(); }

References getCdAlias(), and ClassDef::protection().

qualifiedNameWithTemplateParameters()

DString ClassDefAliasImpl::qualifiedNameWithTemplateParameters ( const ArgumentLists * actualParams = nullptr, uint32_t * actualParamIndex = nullptr ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 688 of file classdef.cpp.

    { return makeQualifiedNameWithTemplateParameters(this,actualParams,actualParamIndex); }

References makeQualifiedNameWithTemplateParameters().

requiresClause()

DString ClassDefAliasImpl::requiresClause ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 759 of file classdef.cpp.

    { return getCdAlias()->requiresClause(); }

References getCdAlias(), and ClassDef::requiresClause().

subClasses()

const BaseClassList & ClassDefAliasImpl::subClasses ( ) const

inlineoverridevirtual

Returns the list of sub classes that directly derive from this class.

Implements ClassDef.

Definition at line 640 of file classdef.cpp.

    { return getCdAlias()->subClasses(); }

References getCdAlias(), and ClassDef::subClasses().

subGrouping()

bool ClassDefAliasImpl::subGrouping ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 753 of file classdef.cpp.

    { return getCdAlias()->subGrouping(); }

References getCdAlias(), and ClassDef::subGrouping().

taglessParent()

const ClassDef * ClassDefAliasImpl::taglessParent ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 731 of file classdef.cpp.

    { return getCdAlias()->taglessParent(); }

References getCdAlias(), and ClassDef::taglessParent().

templateArguments()

const ArgumentList & ClassDefAliasImpl::templateArguments ( ) const

inlineoverridevirtual

Returns the template arguments of this class.

Implements ClassDef.

Definition at line 654 of file classdef.cpp.

    { return getCdAlias()->templateArguments(); }

References getCdAlias(), and ClassDef::templateArguments().

templateMaster()

const ClassDef * ClassDefAliasImpl::templateMaster ( ) const

inlineoverridevirtual

Returns the template master of which this class is an instance.

Returns 0 if not applicable.

Implements ClassDef.

Definition at line 670 of file classdef.cpp.

    { return getCdAlias()->templateMaster(); }

References getCdAlias(), and ClassDef::templateMaster().

templateTypeConstraints()

const ConstraintClassList & ClassDefAliasImpl::templateTypeConstraints ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 680 of file classdef.cpp.

    { return getCdAlias()->templateTypeConstraints(); }

References getCdAlias(), and ClassDef::templateTypeConstraints().

title()

DString ClassDefAliasImpl::title ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 739 of file classdef.cpp.

    { return getCdAlias()->title(); }

References getCdAlias(), and ClassDef::title().

Referenced by writeMemberDeclarations().

typeConstraints()

const ArgumentList & ClassDefAliasImpl::typeConstraints ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 745 of file classdef.cpp.

    { return getCdAlias()->typeConstraints(); }

References getCdAlias(), and ClassDef::typeConstraints().

updateBaseClasses()

void ClassDefAliasImpl::updateBaseClasses ( const BaseClassList & bcd )

inlineoverridevirtual

Update the list of base classes to the one passed.

Implements ClassDef.

Definition at line 809 of file classdef.cpp.

{}

updateSubClasses()

void ClassDefAliasImpl::updateSubClasses ( const BaseClassList & bcd )

inlineoverridevirtual

Update the list of sub classes to the one passed.

Implements ClassDef.

Definition at line 810 of file classdef.cpp.

{}

usedByImplementationClasses()

const UsesClassList & ClassDefAliasImpl::usedByImplementationClasses ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 678 of file classdef.cpp.

    { return getCdAlias()->usedByImplementationClasses(); }

References getCdAlias(), and ClassDef::usedByImplementationClasses().

usedFiles()

const FileList & ClassDefAliasImpl::usedFiles ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 743 of file classdef.cpp.

    { return getCdAlias()->usedFiles(); }

References getCdAlias(), and ClassDef::usedFiles().

usedImplementationClasses()

const UsesClassList & ClassDefAliasImpl::usedImplementationClasses ( ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 676 of file classdef.cpp.

    { return getCdAlias()->usedImplementationClasses(); }

References getCdAlias(), and ClassDef::usedImplementationClasses().

visibleInParentsDeclList()

bool ClassDefAliasImpl::visibleInParentsDeclList ( ) const

inlineoverridevirtual

show this class in the declaration section of its parent?

Implements ClassDef.

Definition at line 652 of file classdef.cpp.

    { return getCdAlias()->visibleInParentsDeclList(); }

References getCdAlias(), and ClassDef::visibleInParentsDeclList().

writeDeclaration()

void ClassDefAliasImpl::writeDeclaration ( OutputList & ol, bool inGroup, int indentLevel, const ClassDef * inheritedFrom, const DString & inheritId ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 786 of file classdef.cpp.

    { getCdAlias()->writeDeclaration(ol,inGroup,indentLevel,inheritedFrom,inheritId); }

References getCdAlias(), and ClassDef::writeDeclaration().

writeDeclarationLink()

void ClassDefAliasImpl::writeDeclarationLink ( OutputList & ol, bool & found, const DString & header, bool localNames ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 772 of file classdef.cpp.

    { getCdAlias()->writeDeclarationLink(ol,found,header,localNames); }

References getCdAlias(), and ClassDef::writeDeclarationLink().

writeDocumentation()

void ClassDefAliasImpl::writeDocumentation ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 778 of file classdef.cpp.

    { getCdAlias()->writeDocumentation(ol); }

References getCdAlias(), and ClassDef::writeDocumentation().

writeDocumentationForInnerClasses()

void ClassDefAliasImpl::writeDocumentationForInnerClasses ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 780 of file classdef.cpp.

    { getCdAlias()->writeDocumentationForInnerClasses(ol); }

References getCdAlias(), and ClassDef::writeDocumentationForInnerClasses().

writeInlineDocumentation()

void ClassDefAliasImpl::writeInlineDocumentation ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 795 of file classdef.cpp.

    { getCdAlias()->writeInlineDocumentation(ol); }

References getCdAlias(), and ClassDef::writeInlineDocumentation().

writeMemberDeclarations()

void ClassDefAliasImpl::writeMemberDeclarations ( OutputList & ol, ClassDefSet & visitedClasses, MemberListType lt, const DString & title, const DString & subTitle = DString(), bool showInline = false, const ClassDef * inheritedFrom = nullptr, MemberListType lt2 = MemberListType::Invalid(), bool invert = false, bool showAlways = false ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 799 of file classdef.cpp.

    { getCdAlias()->writeMemberDeclarations(ol,visitedClasses,lt,title,subTitle,showInline,inheritedFrom,lt2,invert,showAlways); }

References getCdAlias(), MemberListType::Invalid(), title(), and ClassDef::writeMemberDeclarations().

writeMemberList()

void ClassDefAliasImpl::writeMemberList ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 784 of file classdef.cpp.

    { getCdAlias()->writeMemberList(ol); }

References getCdAlias(), and ClassDef::writeMemberList().

writeMemberPages()

void ClassDefAliasImpl::writeMemberPages ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 782 of file classdef.cpp.

    { getCdAlias()->writeMemberPages(ol); }

References getCdAlias(), and ClassDef::writeMemberPages().

writePageNavigation()

void ClassDefAliasImpl::writePageNavigation ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 793 of file classdef.cpp.

    { getCdAlias()->writePageNavigation(ol); }

References getCdAlias(), and ClassDef::writePageNavigation().

writeQuickMemberLinks()

void ClassDefAliasImpl::writeQuickMemberLinks ( OutputList & ol, const MemberDef * md ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 789 of file classdef.cpp.

    { getCdAlias()->writeQuickMemberLinks(ol,md); }

References getCdAlias(), and ClassDef::writeQuickMemberLinks().

writeSummaryLinks()

void ClassDefAliasImpl::writeSummaryLinks ( OutputList & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 791 of file classdef.cpp.

    { getCdAlias()->writeSummaryLinks(ol); }

References getCdAlias(), and ClassDef::writeSummaryLinks().

writeTagFile()

void ClassDefAliasImpl::writeTagFile ( TextStream & ol ) const

inlineoverridevirtual

Implements ClassDef.

Definition at line 797 of file classdef.cpp.

    { getCdAlias()->writeTagFile(ol); }

References getCdAlias(), and ClassDef::writeTagFile().

---

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

• src/classdef.cpp