Classes | Public Member Functions | List of all members
ElementQueryResultsForFile Class Referenceabstract

Copies of elements in a historical state for a given file. More...

#include <DesignHistory.h>

Inheritance diagram for ElementQueryResultsForFile:
RefCounted< IRefCounted > IRefCounted ElementsAsOfQuery

Classes

struct  const_iterator
 

Public Member Functions

DGNPLATFORM_EXPORT DgnFileP GetDgnFileP () const
 Get the file to which this query applies. More...
 
Finding elements in this result set
DGNPLATFORM_EXPORT
ElementChangeType 
GetChangeType (ModelId, ElementId) const
 Get the change type of an element in the set. More...
 
DGNPLATFORM_EXPORT
ElementQueryResult const * 
GetElement (ModelId, ElementId) const
 Get an element in the set. More...
 
DGNPLATFORM_EXPORT ElementHandle GetElemHandle (ModelId, ElementId) const
 Get an element in the set Check return ElementHandle;:IsValid to determine if the element was found. More...
 
DGNPLATFORM_EXPORT UInt32 ComputeElementCount () const
 Get a count of all elements in this set. More...
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 

Iterating and finding models in this result set

typedef ElementQueryResultsForModel value_type
 
typedef const_iterator iterator
 only const iteration is possible More...
 
DGNPLATFORM_EXPORT const_iterator begin () const
 Get the beginning results of the last query, broken out by model. More...
 
DGNPLATFORM_EXPORT const_iterator end () const
 Get the sentinel beyond the end of the results of the last query. More...
 
DGNPLATFORM_EXPORT const_iterator FindModelById (ModelId) const
 See if specified model is in the result set. If not, end() is returned. More...
 
DGNPLATFORM_EXPORT
ElementQueryResultsForModel
GetResultsForModel (ModelId)
 Find an existing ElementQueryResultsForModel for the specified model id or create a new empty one if not found. More...
 

Additional Inherited Members

- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Detailed Description

Copies of elements in a historical state for a given file.

Created by queries.

See also
ElementQueryResultsForModel
Remarks
Required library :DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Typedef Documentation

only const iteration is possible

Member Function Documentation

Get the beginning results of the last query, broken out by model.

DGNPLATFORM_EXPORT UInt32 ComputeElementCount ( ) const

Get a count of all elements in this set.

Get the sentinel beyond the end of the results of the last query.

DGNPLATFORM_EXPORT const_iterator FindModelById ( ModelId  ) const

See if specified model is in the result set. If not, end() is returned.

DGNPLATFORM_EXPORT ElementChangeType GetChangeType ( ModelId  ,
ElementId   
) const

Get the change type of an element in the set.

Returns
ELEMENT_CHANGETYPE_NO_CHANGE if the element is not in the set
DGNPLATFORM_EXPORT DgnFileP GetDgnFileP ( ) const

Get the file to which this query applies.

DGNPLATFORM_EXPORT ElementQueryResult const* GetElement ( ModelId  ,
ElementId   
) const

Get an element in the set.

Returns
NULL if the element is not in the set
DGNPLATFORM_EXPORT ElementHandle GetElemHandle ( ModelId  ,
ElementId   
) const

Get an element in the set Check return ElementHandle;:IsValid to determine if the element was found.

Find an existing ElementQueryResultsForModel for the specified model id or create a new empty one if not found.


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

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.