Skip to main content

The MemberVector Class Reference

A vector of MemberDef object. More...

Declaration​

class MemberVector { ... }

Included Headers​

#include <src/memberlist.h>

Derived Classes​

classMemberList

A list of MemberDef objects as shown in documentation sections. More...

Public Member Typedefs Index​

usingT = MemberDef *
usingVec = std::vector< T >
usingvalue_type = Vec::value_type
usingallocator_type = Vec::allocator_type
usingsize_type = Vec::size_type
usingdifference_type = Vec::difference_type
usingreference = Vec::reference
usingconst_reference = Vec::const_reference
usingiterator = Vec::iterator
usingconst_iterator = Vec::const_iterator

Public Operators Index​

referenceoperator[] (size_type pos)
const_referenceoperator[] (size_type pos) const

Public Member Functions Index​

voidpush_back (const T &value)
voidpush_back (T &&value)
iteratorerase (iterator pos)
iteratorerase (const_iterator pos)
iteratorbegin () noexcept
const_iteratorbegin () const noexcept
iteratorend () noexcept
const_iteratorend () const noexcept
size_typesize () const noexcept
boolempty () const noexcept
referencefront ()
const_referencefront () const
referenceback ()
const_referenceback () const
voidsort ()
voidinSort (MemberDef *md)
voidremove (const MemberDef *md)
boolcontains (const MemberDef *md) const
MemberDef *find (const QCString &name)

Protected Member Attributes Index​

Vecm_members

Public Static Functions Index​

static boollessThan (const MemberDef *md1, const MemberDef *md2)

Description​

A vector of MemberDef object.

Definition at line 34 of file memberlist.h.

Public Member Typedefs​

allocator_type​

using MemberVector::allocator_type = Vec::allocator_type

Definition at line 40 of file memberlist.h.

40 using allocator_type = Vec::allocator_type;

const_iterator​

using MemberVector::const_iterator = Vec::const_iterator

Definition at line 46 of file memberlist.h.

46 using const_iterator = Vec::const_iterator;

const_reference​

using MemberVector::const_reference = Vec::const_reference

Definition at line 44 of file memberlist.h.

44 using const_reference = Vec::const_reference;

difference_type​

using MemberVector::difference_type = Vec::difference_type

Definition at line 42 of file memberlist.h.

42 using difference_type = Vec::difference_type;

iterator​

using MemberVector::iterator = Vec::iterator

Definition at line 45 of file memberlist.h.

45 using iterator = Vec::iterator;

reference​

using MemberVector::reference = Vec::reference

Definition at line 43 of file memberlist.h.

43 using reference = Vec::reference;

size_type​

using MemberVector::size_type = Vec::size_type

Definition at line 41 of file memberlist.h.

41 using size_type = Vec::size_type;

T​

using MemberVector::T = MemberDef*

Definition at line 37 of file memberlist.h.

37 using T = MemberDef*;

value_type​

using MemberVector::value_type = Vec::value_type

Definition at line 39 of file memberlist.h.

39 using value_type = Vec::value_type;

Vec​

using MemberVector::Vec = std::vector<T>

Definition at line 38 of file memberlist.h.

38 using Vec = std::vector<T>;

Public Operators​

operator[]()​

reference MemberVector::operator[] (size_type pos)
 inline

Definition at line 68 of file memberlist.h.

68 reference operator[]( size_type pos ) { return m_members.operator[](pos); }

Reference m_members.

operator[]()​

const_reference MemberVector::operator[] (size_type pos)
 inline

Definition at line 69 of file memberlist.h.

69 const_reference operator[]( size_type pos ) const { return m_members.operator[](pos); }

Reference m_members.

Public Member Functions​

back()​

reference MemberVector::back ()
 inline

Definition at line 65 of file memberlist.h.

65 reference back() { return m_members.back(); }

Reference m_members.

back()​

const_reference MemberVector::back ()
 inline

Definition at line 66 of file memberlist.h.

66 const_reference back() const { return m_members.back(); }

Reference m_members.

begin()​

iterator MemberVector::begin ()
 inline noexcept

Definition at line 54 of file memberlist.h.

54 iterator begin() noexcept { return m_members.begin(); }

Reference m_members.

Referenced by MemberDefImpl::_writeReimplementedBy and refMapToVector.

begin()​

const_iterator MemberVector::begin ()
 inline noexcept

Definition at line 55 of file memberlist.h.

55 const_iterator begin() const noexcept { return m_members.begin(); }

Reference m_members.

contains()​

bool MemberVector::contains (const MemberDef * md)
 inline

Definition at line 89 of file memberlist.h.

89 bool contains(const MemberDef *md) const
90 {
91 return std::find(m_members.begin(),m_members.end(),md)!=m_members.end();
92 }

Reference m_members.

Referenced by ModuleDefImpl::addMemberToModule and FileDefImpl::insertMember.

empty()​

bool MemberVector::empty ()
 inline noexcept

Definition at line 60 of file memberlist.h.

60 bool empty() const noexcept { return m_members.empty(); }

Reference m_members.

Referenced by MemberList::addListReferences, DotGroupCollaboration::addMemberList, generateDEFClassSection, generateDEFSection, PerlModGenerator::generatePerlModForMember, writeGroupTreeNode and writeMemberToIndex.

end()​

iterator MemberVector::end ()
 inline noexcept

Definition at line 56 of file memberlist.h.

56 iterator end() noexcept { return m_members.end(); }

Reference m_members.

Referenced by MemberDefImpl::_writeReimplementedBy and refMapToVector.

end()​

const_iterator MemberVector::end ()
 inline noexcept

Definition at line 57 of file memberlist.h.

57 const_iterator end() const noexcept { return m_members.end(); }

Reference m_members.

erase()​

iterator MemberVector::erase (iterator pos)
 inline

Definition at line 51 of file memberlist.h.

51 iterator erase( iterator pos ) { return m_members.erase(pos); }

Reference m_members.

Referenced by remove.

erase()​

iterator MemberVector::erase (const_iterator pos)
 inline

Definition at line 52 of file memberlist.h.

52 iterator erase( const_iterator pos ) { return m_members.erase(pos); }

Reference m_members.

find()​

MemberDef * MemberVector::find (const QCString & name)
 inline

Definition at line 93 of file memberlist.h.

93 MemberDef *find(const QCString &name)
94 {
95 auto it = std::find_if(m_members.begin(),m_members.end(),[name=name](auto &el) { return el->name()==name; });
96 if (it != m_members.end())
97 {
98 return *it;
99 }
100
101 return nullptr;
102 }

Reference m_members.

Referenced by tryAddEnumDocsToGroupMember.

front()​

reference MemberVector::front ()
 inline

Definition at line 62 of file memberlist.h.

62 reference front() { return m_members.front(); }

Reference m_members.

front()​

const_reference MemberVector::front ()
 inline

Definition at line 63 of file memberlist.h.

63 const_reference front() const { return m_members.front(); }

Reference m_members.

inSort()​

void MemberVector::inSort (MemberDef * md)
 inline

Definition at line 80 of file memberlist.h.

80 void inSort(MemberDef *md)
81 {
82 m_members.insert( std::upper_bound( m_members.begin(), m_members.end(), md, lessThan), md);
83 }

References lessThan and m_members.

push_back()​

void MemberVector::push_back (const T & value)
 inline

Definition at line 48 of file memberlist.h.

48 void push_back( const T& value ) { m_members.push_back(value); }

Reference m_members.

Referenced by MemberGroup::addGroupedInheritedMembers, ModuleDefImpl::addMemberToModule, FileDefImpl::insertMember and NamespaceDefImpl::insertMember.

push_back()​

void MemberVector::push_back (T && value)
 inline

Definition at line 49 of file memberlist.h.

49 void push_back( T&& value ) { m_members.push_back(std::move(value)); }

Reference m_members.

remove()​

void MemberVector::remove (const MemberDef * md)
 inline

Definition at line 84 of file memberlist.h.

84 void remove(const MemberDef *md)
85 {
86 auto it = std::find(m_members.begin(),m_members.end(),md);
87 if (it!=m_members.end()) erase(it);
88 }

References erase and m_members.

Referenced by addMembersToMemberGroup, FileDefImpl::removeMemberFromList and GroupDefImpl::removeMemberFromList.

size()​

size_type MemberVector::size ()
 inline noexcept

Definition at line 59 of file memberlist.h.

59 size_type size() const noexcept { return m_members.size(); }

Reference m_members.

sort()​

void MemberVector::sort ()
 inline

Definition at line 76 of file memberlist.h.

76 void sort()
77 {
78 std::stable_sort(m_members.begin(),m_members.end(),lessThan);
79 }

References lessThan and m_members.

Referenced by FileDefImpl::sortMemberLists, FileDefImpl::writeDocumentation and NamespaceDefImpl::writeDocumentation.

Protected Member Attributes​

m_members​

Vec MemberVector::m_members
 protected

Definition at line 104 of file memberlist.h.

104 Vec m_members;

Referenced by MemberList::addListReferences, back, back, begin, begin, contains, MemberList::countDecMembers, MemberList::countDocMembers, MemberList::countEnumValues, MemberList::countInheritableMembers, MemberList::declVisible, empty, end, end, erase, erase, find, MemberList::findSectionsInDocumentation, front, front, inSort, operator[], operator[], push_back, push_back, remove, MemberList::setAnchors, MemberList::setAnonymousEnumType, size, sort, MemberList::writeDocumentation, MemberList::writeDocumentationPage, MemberList::writePlainDeclarations, MemberList::writeSimpleDocumentation and MemberList::writeTagFile.

Public Static Functions​

lessThan()​

bool MemberVector::lessThan (const MemberDef * md1, const MemberDef * md2)
 inline static

Definition at line 72 of file memberlist.h.

72 static bool lessThan(const MemberDef *md1,const MemberDef *md2)
73 {
74 return genericCompareMembers(md1,md2)<0;
75 }

Reference genericCompareMembers.

Referenced by inSort and sort.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.