HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_RelationshipArray Class Reference

Holds pointers to a number of SIM_Relationships. More...

#include <SIM_RelationshipArray.h>

+ Inheritance diagram for SIM_RelationshipArray:

Public Member Functions

 SIM_RelationshipArray ()
 
virtual ~SIM_RelationshipArray ()
 
void forceUniqueRelationshipName (UT_String &name) const
 
SIM_RelationshipfindRelationshipByName (const char *name) const
 Find the relationship with the specified name. More...
 
int findRelationshipPosByName (const char *name) const
 Find the position of the relationship with the specified name. More...
 
void filter (const SIM_DataFilter &filter, SIM_DataArray &rels) const
 
void filterConst (const SIM_DataFilter &filter, SIM_ConstDataArray &rels) const
 
- Public Member Functions inherited from SIM_PtrArraySorted< SIM_Relationship * >
 SIM_PtrArraySorted ()
 
 SIM_PtrArraySorted (typename UT_ValArray< SIM_Relationship * >::Comparator comparator)
 
virtual ~SIM_PtrArraySorted ()
 
void setComparator (typename UT_ValArray< SIM_Relationship * >::Comparator cmp)
 
void sort ()
 
exint size () const
 
void setSize (exint newsize)
 
void setCapacity (exint newcapacity)
 
exint entries () const
 
void entries (int newnumentries)
 
void resize (int newsize)
 
SIM_Relationshipoperator() (int index) const
 
SIM_Relationshiplast () const
 
int find (SIM_Relationship *ptr) const
 
bool operator== (const SIM_PtrArraySorted &cmp) const
 
bool containsAny (const SIM_PtrArraySorted &cmp) const
 
bool containsFully (const SIM_PtrArraySorted &cmp) const
 
void remove (int index)
 
void remove (SIM_Relationship *ptr)
 
void remove (const SIM_PtrArraySorted &src)
 
void keepOnly (const SIM_PtrArraySorted &src)
 
const SIM_PtrArraySortedoperator= (const SIM_PtrArraySorted &src)
 
int add (SIM_Relationship *ptr)
 
void set (const SIM_PtrArraySorted &src)
 
void setUnsorted (const UT_ValArray< SIM_Relationship * > &src, SIM_PtrArraySorted &duplicates)
 
void merge (const SIM_PtrArraySorted &src)
 
void mergeSelected (const SIM_PtrArraySorted &src, bool(*selectfunc)(SIM_Relationship *))
 
void appendUnsafe (SIM_Relationship *ptr)
 
const UT_ValArray
< SIM_Relationship * > & 
getRawArray () const
 
UT_ValArray< SIM_Relationship * > & getRawArray ()
 

Static Public Member Functions

static int compareRelationshipNames (SIM_Relationship *const *, SIM_Relationship *const *)
 Function for sorting pointers according to the relationship name. More...
 

Detailed Description

Holds pointers to a number of SIM_Relationships.

Definition at line 19 of file SIM_RelationshipArray.h.

Constructor & Destructor Documentation

SIM_RelationshipArray::SIM_RelationshipArray ( )
virtual SIM_RelationshipArray::~SIM_RelationshipArray ( )
virtual

Member Function Documentation

static int SIM_RelationshipArray::compareRelationshipNames ( SIM_Relationship *const ,
SIM_Relationship *const  
)
static

Function for sorting pointers according to the relationship name.

void SIM_RelationshipArray::filter ( const SIM_DataFilter filter,
SIM_DataArray rels 
) const

Get all relationships of a particular type. Note that the filter is applied to the SIM_RelationshipData subdata of the SIM_Relationship, not to the SIM_Relationship itself.

void SIM_RelationshipArray::filterConst ( const SIM_DataFilter filter,
SIM_ConstDataArray rels 
) const

Get const pointers to all relationships of a particular type. As with filter(), the SIM_DataFilter is applied to the SIM_RelationshipData subdata, not the SIM_Relationship itself.

SIM_Relationship* SIM_RelationshipArray::findRelationshipByName ( const char *  name) const

Find the relationship with the specified name.

int SIM_RelationshipArray::findRelationshipPosByName ( const char *  name) const

Find the position of the relationship with the specified name.

void SIM_RelationshipArray::forceUniqueRelationshipName ( UT_String name) const

Change the supplied name to make it different from any other relationship in this array.


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