Functions | |
DgnModelP | elementRef_getCache (ElementRefP pElem) |
Given an ElementRefP, return the DgnModelP that holds it. More... | |
DgnFileP | elementRef_getDgnFileObj (ElementRefP pElem) |
Given an ElementRefP, return the DgnFile that holds it. More... | |
UInt32 | elementRef_getFilePos (ElementRefP pElem) |
Given an ElementRefP, return it's filepos. More... | |
void | elementRef_getElementHeader (ElementRefP pElem, Elm_hdrP hdr) |
Given an ElementRefP, return just its header. More... | |
size_t | elementRef_getElement (ElementRefP pElem, MSElementP pEl, size_t inSize) |
Given an ElementRefP, return the element data. More... | |
bool | elementRef_isEOF (ElementRefP pElem) |
Test whether the given ElementRefP is the "end of file" marker. More... | |
bool | elementRef_isComplexComponent (ElementRefP pElem) |
Test whether the given ElementRefP is a complex component. More... | |
bool | elementRef_isDirty (ElementRefP pElem) |
Test whether the "dirty" flag on an element has been set. More... | |
bool | elementRef_isDeleted (ElementRefP pElem) |
Test whether the element has been deleted. More... | |
bool | elementRef_isCacheDeleted (ElementRefP pElem) |
Test whether the element is part of a DgnModel that has been deleted. More... | |
bool | elementRef_isNew (ElementRefP pElem) |
Check the "new" flag on an element. More... | |
bool | elementRef_isHilited (ElementRefP pElem, DgnModelRefP modelRef) |
Check the "hilite" flag on an elementRef/ModelRef combination. More... | |
DgnPlatform::ElementHiliteState | elementRef_getHiliteState (ElementRefP pElem, DgnModelRefP modelRef) |
Check the "hilite" flag on an elementRef/ModelRef combination and return the current state. More... | |
bool | elementRef_isInSelectionSet (ElementRefP pElem, DgnModelRefP modelRef) |
Check to determine whether an elementRef/ModelRef pair is currently in the selection set. More... | |
bool | elementRef_isInDisplaySet (ElementRefP pElem, DgnModelRefP modelRef) |
Check to determine whether an elementRef/ModelRef pair is currently in the display set. More... | |
bool | elementRef_isIncludedForModelRef (ElementRefP pElem, DgnModelRefP modelRef) |
Check to determine whether an elementRef is included for the given modelRef. More... | |
bool | elementRef_hasDependents (ElementRefP elemRef) |
Test whether the specified element has dependents. More... | |
int | elementRef_getDependents (ElementRefP baseElem, ElementRefP *pDependents, int nDependents) |
Get a list of IDs of elements dependent on the specified element. More... | |
bool | elementRef_isDependent (ElementRefP pRoot, ElementRefP pDependent) |
Query if the 'dependent' element is a dependent of the 'root' element or of any of the elements on which it depends, and so on. More... | |
DependentElemRef | elementRef_getFirstDependent (ElementRefP pElem) |
Given an ElementRefP, get the first element that is a dependent of this element, in the form of a DependentElemRef. More... | |
ElementRefP | elementDependent_getElemRef (DependentElemRef thisDep) |
Given a DependentElemRef, get the ElementRefP for the dependent element. More... | |
DependentElemRef | elementDependent_getNext (DependentElemRef thisDep) |
Given a DependentElemRef, get a DependentElemRef for the next element dependent on the same base element. More... | |
DgnPlatform::ElementId | elementRef_getElemID (ElementRefP elemRef) |
Given an ElementRefP, get the ID of its element. More... | |
int | elementRef_getElemType (ElementRefP elemRef) |
Given an ElementRefP, get the type of its element. More... | |
DgnPlatform::ElementRefType | elementRef_getRefType (ElementRefP elemRef) |
Given an ElementRefP, get its type (e.g. More... | |
UInt32 | elementRef_getElemLevel (ElementRefP elemRef) |
Given an ElementRefP, get the level of its element. More... | |
size_t | elementRef_getElemSize (ElementRefP elemRef) |
Given an ElementRefP, get the size of its element, in bytes. More... | |
bool | elementRef_isImmediateDependent (ElementRefP pRoot, ElementRefP pDependent) |
Query if the 'dependent' element is an immediate dependent of the 'root' element. More... | |
int | elementRef_getElemArchive (ElementRefP elemRef) |
Given an ElementRefP, get the state of the archive flags. More... | |
int | elementRef_getXAttributeArchive (ElementRefP elemRef) |
Check if the ElementRefP's XAttribute archive flag is ste. More... | |
int | elementRef_getElemAttrOffset (ElementRefP elemRef) |
Given an ElementRefP, get the Attribute Offset for this element. More... | |
bool | elementRef_isComplexHeader (ElementRefP elemRef) |
Given an ElementRefP, determine whether it is a complex header. More... | |
int | elementRef_getComponentCount (ElementRefP elemRef) |
Given an ElementRefP, get the number of children of its element. More... | |
ElementRefP | elementRef_getParent (ElementRefP pElem) |
Given an ElementRefP, return its parent's ElementRefP (returns NULL for non-complex elements). More... | |
ElementRefP elementDependent_getElemRef | ( | DependentElemRef | thisDep | ) |
Given a DependentElemRef, get the ElementRefP for the dependent element.
[in] | thisDep | A DependentElemRef received from a previous call to either. elementRef_getFirstDependent or elementDependent_getNext. |
DependentElemRef elementDependent_getNext | ( | DependentElemRef | thisDep | ) |
Given a DependentElemRef, get a DependentElemRef for the next element dependent on the same base element.
[in] | thisDep | A DependentElemRef received from a previous call to either. elementRef_getFirstDependent or elementDependent_getNext. |
DgnModelP elementRef_getCache | ( | ElementRefP | pElem | ) |
Given an ElementRefP, return the DgnModelP that holds it.
[in] | pElem | Get the DgnModel containing this ElementRefP. |
int elementRef_getComponentCount | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the number of children of its element.
For simple, non-complex headers, this will be 0.
[in] | elemRef | The ElementRefP for the element to test. |
int elementRef_getDependents | ( | ElementRefP | baseElem, |
ElementRefP * | pDependents, | ||
int | nDependents | ||
) |
Get a list of IDs of elements dependent on the specified element.
[in] | baseElem | The ElementRefP for the element that has dependents. |
[out] | pDependents | The list of element IDs of dependent elements. |
[in] | nDependents | The maximum number of element IDs to return in pDependents. |
DgnFileP elementRef_getDgnFileObj | ( | ElementRefP | pElem | ) |
Given an ElementRefP, return the DgnFile that holds it.
[in] | pElem | Get the DgnFile containing this ElementRefP. |
int elementRef_getElemArchive | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the state of the archive flags.
[in] | elemRef | The ElementRefP to get the archive flags from. |
int elementRef_getElemAttrOffset | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the Attribute Offset for this element.
[in] | elemRef | The ElementRefP to get the Attribute Offset from. |
size_t elementRef_getElement | ( | ElementRefP | pElem, |
MSElementP | pEl, | ||
size_t | inSize | ||
) |
Given an ElementRefP, return the element data.
[in] | pElem | The ElementRefP to get the element data from. |
[out] | pEl | Buffer to receive the element. |
[in] | inSize | The maximum number of bytes of data to copy. |
void elementRef_getElementHeader | ( | ElementRefP | pElem, |
Elm_hdrP | hdr | ||
) |
Given an ElementRefP, return just its header.
[in] | pElem | The ElementRefP to get the header from. |
[out] | hdr | The header for pElem. |
DgnPlatform::ElementId elementRef_getElemID | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the ID of its element.
[in] | elemRef | The ElementRefP to get the ID from. |
UInt32 elementRef_getElemLevel | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the level of its element.
[in] | elemRef | The ElementRefP to get the level from. |
size_t elementRef_getElemSize | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the size of its element, in bytes.
[in] | elemRef | The ElementRefP to get the size of. |
int elementRef_getElemType | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get the type of its element.
[in] | elemRef | The ElementRefP to get the type from. |
UInt32 elementRef_getFilePos | ( | ElementRefP | pElem | ) |
Given an ElementRefP, return it's filepos.
[in] | pElem | The ElementRefP to get the filepos of. |
DependentElemRef elementRef_getFirstDependent | ( | ElementRefP | pElem | ) |
Given an ElementRefP, get the first element that is a dependent of this element, in the form of a DependentElemRef.
[in] | pElem | The ElementRefP to get the first dependent from. |
DgnPlatform::ElementHiliteState elementRef_getHiliteState | ( | ElementRefP | pElem, |
DgnModelRefP | modelRef | ||
) |
Check the "hilite" flag on an elementRef/ModelRef combination and return the current state.
[in] | pElem | The ElementRefP for the element to test. |
[in] | modelRef | The DgnModelRefP to test. |
ElementRefP elementRef_getParent | ( | ElementRefP | pElem | ) |
Given an ElementRefP, return its parent's ElementRefP (returns NULL for non-complex elements).
[in] | pElem | The ElementRefP of a child element. |
DgnPlatform::ElementRefType elementRef_getRefType | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, get its type (e.g.
cache, transient, etc.)
[in] | elemRef | The ElementRefP to get the type from. |
int elementRef_getXAttributeArchive | ( | ElementRefP | elemRef | ) |
Check if the ElementRefP's XAttribute archive flag is ste.
[in] | elemRef | The ElementRefP to get the archive flags from. |
bool elementRef_hasDependents | ( | ElementRefP | elemRef | ) |
Test whether the specified element has dependents.
[in] | elemRef | The ElementRefP for the element to test. |
bool elementRef_isCacheDeleted | ( | ElementRefP | pElem | ) |
Test whether the element is part of a DgnModel that has been deleted.
Elements in a deleted DgnModel are held in the DgnModel, and their ElementRefs remain valid, until the DgnModel is closed or compressed.
[in] | pElem | The ElementRefP for the element to test. |
bool elementRef_isComplexComponent | ( | ElementRefP | pElem | ) |
Test whether the given ElementRefP is a complex component.
[in] | pElem | The ElementRefP to test. |
bool elementRef_isComplexHeader | ( | ElementRefP | elemRef | ) |
Given an ElementRefP, determine whether it is a complex header.
[in] | elemRef | The ElementRefP for the element to test. |
bool elementRef_isDeleted | ( | ElementRefP | pElem | ) |
Test whether the element has been deleted.
Deleted elements are held in the DgnModel, and their ElementRefs remain valid, until the DgnModel is closed or compressed.
[in] | pElem | The ElementRefP for the element to test. |
bool elementRef_isDependent | ( | ElementRefP | pRoot, |
ElementRefP | pDependent | ||
) |
Query if the 'dependent' element is a dependent of the 'root' element or of any of the elements on which it depends, and so on.
[in] | pRoot | The root ElementRefP that has dependents |
[in] | pDependent | The ElementRefP to look for among the root's dependents |
true
if pDependent is a dependent of pRoot; false
otherwise. bool elementRef_isDirty | ( | ElementRefP | pElem | ) |
Test whether the "dirty" flag on an element has been set.
The dirty flag indicates that the element has been modified in some way since the last save operation and needs to be written to the disk.
[in] | pElem | The ElementRefP to test. |
bool elementRef_isEOF | ( | ElementRefP | pElem | ) |
Test whether the given ElementRefP is the "end of file" marker.
This is necessary for DgnModel iterators.
[in] | pElem | The ElementRefP to test. |
bool elementRef_isHilited | ( | ElementRefP | pElem, |
DgnModelRefP | modelRef | ||
) |
Check the "hilite" flag on an elementRef/ModelRef combination.
[in] | pElem | The ElementRefP for the element to test. |
[in] | modelRef | The DgnModelRefP to test. |
bool elementRef_isImmediateDependent | ( | ElementRefP | pRoot, |
ElementRefP | pDependent | ||
) |
Query if the 'dependent' element is an immediate dependent of the 'root' element.
[in] | pRoot | The root ElementRefP that has dependents. |
[in] | pDependent | The ElementRefP to look for among the root's dependents. |
true
if pDependent is a dependent of pRoot; false
otherwise. true
, then you would find pDependent in the list of elements returned by calling elementRef_getDependents (pRoot). bool elementRef_isIncludedForModelRef | ( | ElementRefP | pElem, |
DgnModelRefP | modelRef | ||
) |
Check to determine whether an elementRef is included for the given modelRef.
[in] | pElem | The ElementRefP for the element to test. |
[in] | modelRef | The DgnModelRefP to test. |
bool elementRef_isInDisplaySet | ( | ElementRefP | pElem, |
DgnModelRefP | modelRef | ||
) |
Check to determine whether an elementRef/ModelRef pair is currently in the display set.
[in] | pElem | The ElementRefP for the element to test. |
[in] | modelRef | The DgnModelRefP to test. |
bool elementRef_isInSelectionSet | ( | ElementRefP | pElem, |
DgnModelRefP | modelRef | ||
) |
Check to determine whether an elementRef/ModelRef pair is currently in the selection set.
[in] | pElem | The ElementRefP for the element to test. |
[in] | modelRef | The DgnModelRefP to test. |
bool elementRef_isNew | ( | ElementRefP | pElem | ) |
Check the "new" flag on an element.
[in] | pElem | The ElementRefP for the element to test. |