Typedefs | Functions
filtertable.fdf File Reference
#include "filtertable.h"

Typedefs

typedef StatusInt(* FilterTraverseCallback )(FilterID filterIdIn, CallbackArgP pUserArgIn)
 UserFunction called when traversing filter. More...
 
typedef StatusInt(* MemberTraverseCallback )(FilterMemberID memberIdIn, CallbackArgP pUserArgIn)
 UserFunction called when traversing member. More...
 
typedef StatusInt(* FilterIteratorTraverseCallback )(FilterID filterIdIn, CallbackArgP pUserArgIn)
 UserFunction called when traversing filters. More...
 

Functions

StatusInt mdlFilterTable_initialize (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, bool bCreateIfRequiredIn)
 Filters give the ability to create simple "query"-type expressions which can then be evaluated on specified data. More...
 
bool mdlFilterTable_isValid (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Check if a filter table with specified name exists. More...
 
StatusInt mdlFilterTable_rewrite (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Write the filter table data to file. More...
 
int mdlFilterTable_mergeFilterTableDescr (MSElementDescrP pFilterTableDescrIO, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Merge a given filter-table descriptor into the filters of specified filter-table. More...
 
StatusInt mdlFilterTable_traverseFilters (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterTraverseCallback pUserFunctionIn, CallbackArgP pUserArgIn)
 Traverse thru' all the filters of given filter table name. More...
 
StatusInt mdlFilterTable_traverseMembers (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, MemberTraverseCallback pUserFunctionIn, CallbackArgP pUserArgIn)
 Traverse thru' all the members of given filter table name. More...
 
StatusInt mdlFilterTable_getFilterCount (int *pFilterCountOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, UShort filterCountTypeIn)
 Get the number of filters of given filter table. More...
 
StatusInt mdlFilter_getChildCount (int *pChildFilterCountOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iParentFilterIdIn)
 Get number of child filters for specified parent filter. More...
 
bool mdlFilter_isValid (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Check if filter id is valid. More...
 
bool mdlFilter_isValidByName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iParentFilterIdIn, WCharCP pFilterNameIn)
 Check if a filter with specified name is valid. More...
 
StatusInt mdlFilter_getActive (FilterID *piActiveFilterIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Get the active filter. More...
 
StatusInt mdlFilter_getName (WCharP pFilterNameOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get Filter Name. More...
 
const WChar * mdlFilter_getPathName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get Filter Path Name - name of Filter appended by names of all its parents. More...
 
StatusInt mdlFilter_getDescription (WCharP pFilterDescriptionOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get Filter Description. More...
 
StatusInt mdlFilter_getType (UShort *pFilterTypeOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get Filter Type. More...
 
StatusInt mdlFilter_getPersistent (bool *pbPersistentOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get if a Filter is persistent. More...
 
StatusInt mdlFilter_getExternal (bool *pbExternalOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get if a Filter is external. More...
 
bool mdlFilter_isPersistent (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Check if a Filter is persistent. More...
 
bool mdlFilter_isExternal (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Check if a Filter is external. More...
 
StatusInt mdlFilter_getIdFromName (FilterID *pFilterIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iParentFilterIdIn, WCharCP pFilterNameIn)
 Get id of filter which has specified name. More...
 
int mdlFilter_getIdFromPathName (FilterID *pFilterIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pPathNameIn)
 Get id of filter which has given full specified path name. More...
 
StatusInt mdlFilter_create (FilterID *piFilterIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pFilterNameIn, UShort filterTypeIn)
 Create a new filter in specified filter-table. More...
 
int mdlFilter_createWithPathName (FilterID *piFilterIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pPathNameIn, UShort filterTypeIn)
 Create a new filter in specified filter-table. More...
 
StatusInt mdlFilter_delete (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Delete filter. More...
 
StatusInt mdlFilter_setActive (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iActiveFilterIdIn)
 Set the active filter. More...
 
StatusInt mdlFilter_setName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, WCharCP pNameIn)
 Set filter name. More...
 
StatusInt mdlFilter_setDescription (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, WCharCP pDescriptionIn)
 Set filter name. More...
 
StatusInt mdlFilter_setType (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, UShort filterTypeIn)
 Set Filter Type. More...
 
StatusInt mdlFilter_setPersistent (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, bool bPersistentIn)
 Set if a Filter is persistent. More...
 
StatusInt mdlFilter_getParentId (FilterID *pParentFilterIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Get Filter Parent. More...
 
bool mdlFilter_isParent (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Check if a filter is a parent. More...
 
bool mdlFilter_isChild (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Check if a filter is a child. More...
 
StatusInt mdlFilter_setParentId (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterID parentFilterIdIn)
 Set Filter Parent. More...
 
StatusInt mdlFilter_copyFilterData (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID destFilterIdIn, FilterID sourceFilterIdIn)
 Copy filter data from source filter to destination filter. More...
 
StatusInt mdlFilter_apply (bool *pPassFlagOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, int numValuesIn, FilterMemberID *pMemberIdArrayIn, FilterValue *pFilterValueArrayIn)
 Apply a filter to specified data, to check if the data passes the filter. More...
 
bool mdlFilter_hasMember (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn)
 Check if filter has specified member. More...
 
StatusInt mdlFilter_getLibraryName (WChar *pLibraryNameOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 Return the source library name of an external filter. More...
 
StatusInt mdlFilter_getComposeExpression (WChar *pComposeExpressionStringOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn)
 the way the Filter is composed in the form of a string. More...
 
StatusInt mdlFilter_setComposeExpression (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, WCharCP pComposeExpressionStringIn)
 Filter may be composed of other filters. More...
 
FilterMemberID mdlFilterMember_getNext (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
 Get the next member after given member. More...
 
FilterMemberID mdlFilterMember_getPrevious (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
 Get the previous member before given member. More...
 
FilterMemberID mdlFilterMember_getFirst (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Get the first member. More...
 
FilterMemberID mdlFilterMember_getLast (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Get the last member. More...
 
bool mdlFilterMember_isValid (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
 Check if a member with specified id is valid. More...
 
bool mdlFilterMember_isValidByName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pMemberNameIn)
 Check if a member with specified name is valid. More...
 
StatusInt mdlFilterMember_create (FilterMemberID *piMemberIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pMemberNameIn, UShort memberTypeIn)
 Create a new member for specified filter-table. More...
 
StatusInt mdlFilterMember_getType (UShort *pMemberTypeOut, DgnModelRefP pModelRefIn, const WChar *pFilterTableNameIn, FilterMemberID iMemberIdIn)
 Get member type. More...
 
StatusInt mdlFilterMember_getName (WChar *pMemberNameOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
 Get member name. More...
 
StatusInt mdlFilterMember_getIdFromName (FilterMemberID *pMemberIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pMemberNameIn)
 Get id of member with specified name. More...
 
StatusInt mdlFilterMember_delete (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
 Delete member. More...
 
StatusInt mdlFilterMember_setName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn, WCharCP pNameIn)
 Set name of filter member. More...
 
StatusInt mdlFilterMember_getExpressionSize (int *pStringSizeOut, DgnModelRefP pModelRefIn, const WChar *pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn)
 Get filter-member expression string size. More...
 
StatusInt mdlFilterMember_getExpression (WChar *pExpressionStringOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn)
 Get filter-member expression string. More...
 
StatusInt mdlFilterMember_setExpression (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn, WCharCP pExpressionStringIn)
 Set filter-member expression string. More...
 
StatusInt mdlFilterMember_apply (bool *pPassFlagOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn, FilterValue *pFilterValueIn)
 Apply a filter member's expression string to specified value, to check if the value passes the filter member. More...
 
StatusInt mdlFilterValue_applyStringExpression (bool *pPassFlagOut, UShort expressionTypeIn, WCharCP pStringExpressionIn, WCharCP pStringValueIn)
 Apply a string expression to specified string-value to check if the string value passes the expression. More...
 
StatusInt mdlFilterValue_applyIntegerExpression (bool *pPassFlagOut, UShort expressionTypeIn, WCharCP pIntegerExpressionIn, int integerValueIn)
 Check if integer value passes integer expression. More...
 
StatusInt mdlFilterValue_applyBooleanExpression (bool *pPassFlagOut, UShort expressionTypeIn, WCharCP pBooleanExpressionIn, bool booleanValueIn)
 Apply a boolean expression to specified boolean-value to check if the value passes the expression. More...
 
StatusInt mdlFilterValue_applyDoubleExpression (bool *pPassFlagOut, UShort expressionTypeIn, WCharCP pDoubleExpressionIn, double doubleValueIn)
 Apply a double expression to specified double-value to check if the value passes the expression. More...
 
int mdlFilterValue_remapIntegerExpression (bool *pbChangeOut, WStringP pRemappedExpressionOut, WCharCP pIntegerExpressionIn, int *pOriginalIntegerArrayIn, int *pRemapIntegerArrayIn, int numIntegersIn)
 Remap integers in an integer expression to a set of new integers. More...
 
bool mdlFilterName_hasValidCharacters (const WChar *pNameStringIn)
 Check if specified Name String is valid. More...
 
void mdlFilterName_getInvalidCharacters (const WChar **pInvalidCharactersOut)
 Get the list of Invalid characters. More...
 
void mdlFilterName_replaceInvalidCharacters (WChar *pNameStringIn, WChar replacementCharIn)
 
Replace all invalid characters in specified Name String with another

character More...

 
FilterIteratorP mdlFilterIterator_create (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
 Create a new filter iterator to iterate thru' filters. More...
 
void mdlFilterIterator_free (FilterIteratorP *ppFilterIteratorIn)
 Free a filter iterator which is not required. More...
 
StatusInt mdlFilterIterator_setModelRef (FilterIteratorP pFilterIteratorIn, DgnModelRefP pModelRefIn)
 Set model ref on whose filters to iterate. More...
 
StatusInt mdlFilterIterator_setFilterTable (FilterIteratorP pFilterIteratorIn, WCharCP pFilterTableNameIn)
 Set filter table on whose filters to iterate. More...
 
StatusInt mdlFilterIterator_reset (FilterIteratorP pFilterIteratorIn)
 Reset the iteration process to restart from the beginning. More...
 
StatusInt mdlFilterIterator_setIterateType (FilterIteratorP pFilterIteratorIn, UInt iterateTypeIn)
 Set iteration type. More...
 
StatusInt mdlFilterIterator_setIterateOrder (FilterIteratorP pFilterIteratorIn, UInt iterateOrderIn)
 Set iteration order - by id or by name. More...
 
StatusInt mdlFilterIterator_setParentFilterId (FilterIteratorP pFilterIteratorIn, FilterID iParentFilterIdIn)
 Set parent filter-id, whose children are to be iterated on. More...
 
FilterID mdlFilterIterator_getNext (FilterIteratorP pFilterIteratorIn)
 Get next filter. More...
 
FilterID mdlFilterIterator_getPrevious (FilterIteratorP pFilterIteratorIn)
 Get previous filter. More...
 
FilterID mdlFilterIterator_getFirst (FilterIteratorP pFilterIteratorIn)
 Get first filter. More...
 
FilterID mdlFilterIterator_getLast (FilterIteratorP pFilterIteratorIn)
 Get last filter. More...
 
StatusInt mdlFilterIterator_traverse (FilterIteratorP pFilterIteratorIn, FilterIteratorTraverseCallback pUserFunctionIn, CallbackArgP pUserArgIn)
 Traverse through all filter entries as specified in the iterator. More...
 
int mdlFilterLibrary_getFilterTable (MSElementDescrH ppFilterLibraryDescrOut, FilterLibraryFormat *pLibraryFormatOut, WCharCP pFilterTableNameIn, WCharCP pFileNameIn, FilterLibraryFormat libraryFormatIn)
 Get a filter-library in the format of a filter-table descriptor from specified file. More...
 
int mdlFilterLibrary_import (WCharCP pFilterTableNameIn, WCharCP pFileNameIn, FilterLibraryFormat libraryFormatIn)
 Import filter-library into the current-file. More...
 
StatusInt mdlFilterError_getMessage (WChar *pErrorMessageOut, int stringSizeIn, int errorStatusIn)
 Get a message string describing a returned filter-error status. More...
 
StatusInt mdlFilterError_outputToMessageCenter (DgnPlatform::OutputMessagePriority errorMessagePriorityIn, int errorStatusIn)
 Output to the message center a message string describing a returned filter-error status. More...
 

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