Modules | |
Filter Tables | |
Filter Members | |
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 | 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... | |
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... | |
typedef StatusInt(* FilterIteratorTraverseCallback)(FilterID filterIdIn, CallbackArgP pUserArgIn) |
UserFunction called when traversing filters.
[in] | filterIdIn | filter-id of filter being traversed. |
[in] | pUserArgIn | user argument that specified in the mdlFilterIterator_traverse function. |
typedef StatusInt(* FilterTraverseCallback)(FilterID filterIdIn, CallbackArgP pUserArgIn) |
UserFunction called when traversing filter.
[in] | filterIdIn | filter-id of filter being traversed. |
[in] | pUserArgIn | user argument that specified in the mdlFilterTable_traverseFilters function. |
typedef StatusInt(* MemberTraverseCallback)(FilterMemberID memberIdIn, CallbackArgP pUserArgIn) |
UserFunction called when traversing member.
[in] | memberIdIn | member-id of member being traversed. |
[in] | pUserArgIn | user argument that specified in the mdlFilterTable_traverseMembers function. |
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.
[out] | pPassFlagOut | true if the value passes the filter member, else false |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
[in] | numValuesIn | number of values in the data |
[in] | pMemberIdArrayIn | array of member ids corresponding to the individual values |
[in] | pFilterValueArrayIn | array of individual values in the data |
StatusInt mdlFilter_copyFilterData | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | destFilterIdIn, | ||
FilterID | sourceFilterIdIn | ||
) |
Copy filter data from source filter to destination filter.
This does not change the id, name and type of the destination filter.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | destFilterIdIn | id of filter to copy into |
[in] | sourceFilterIdIn | id of filter to copy from |
StatusInt mdlFilter_create | ( | FilterID * | piFilterIdOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
WCharCP | pFilterNameIn, | ||
UShort | filterTypeIn | ||
) |
Create a new filter in specified filter-table.
[out] | piFilterIdOut | id of filter created |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | pFilterNameIn | filter name |
[in] | filterTypeIn | filter type |
int mdlFilter_createWithPathName | ( | FilterID * | piFilterIdOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
WCharCP | pPathNameIn, | ||
UShort | filterTypeIn | ||
) |
Create a new filter in specified filter-table.
The path-name specifies where in the filter-hierarchy the new filter is created. The last name in the path-name is the name to be assigned to the new filter. The rest of the names in the path-name defines parent filters in the hierarchy. If some parent in the hierarchy is not present, then the missing parent filters are silently created.
[out] | piFilterIdOut | id of filter created |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | pPathNameIn | filter name |
[in] | filterTypeIn | filter type |
StatusInt mdlFilter_delete | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Delete filter.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | id of filter to delete |
StatusInt mdlFilter_getActive | ( | FilterID * | piActiveFilterIdOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn | ||
) |
Get the active filter.
[out] | piActiveFilterIdOut | active filter id |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
StatusInt mdlFilter_getChildCount | ( | int * | pChildFilterCountOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iParentFilterIdIn | ||
) |
Get number of child filters for specified parent filter.
[out] | pChildFilterCountOut | child filter count |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iParentFilterIdIn | parent filter id |
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.
[out] | pComposeExpressionStringOut | compose expression string |
[in] | stringSizeIn | number of characters pComposeExpressionStringOut can hold |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getDescription | ( | WCharP | pFilterDescriptionOut, |
int | stringSizeIn, | ||
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get Filter Description.
[out] | pFilterDescriptionOut | filter description |
[in] | stringSizeIn | number of characters pFilterDescriptionOut can hold |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getExternal | ( | bool * | pbExternalOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get if a Filter is external.
[out] | pbExternalOut | external flag |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getIdFromName | ( | FilterID * | pFilterIdOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iParentFilterIdIn, | ||
WCharCP | pFilterNameIn | ||
) |
Get id of filter which has specified name.
[out] | pFilterIdOut | filter id |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iParentFilterIdIn | parent filter id |
[in] | pFilterNameIn | filter name |
int mdlFilter_getIdFromPathName | ( | FilterID * | pFilterIdOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
WCharCP | pPathNameIn | ||
) |
Get id of filter which has given full specified path name.
[out] | pFilterIdOut | filter id |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | pPathNameIn | filter path name |
StatusInt mdlFilter_getLibraryName | ( | WChar * | pLibraryNameOut, |
int | stringSizeIn, | ||
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Return the source library name of an external filter.
[out] | pLibraryNameOut | library name |
[in] | stringSizeIn | number of characters pLibraryNameOut can hold |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getName | ( | WCharP | pFilterNameOut, |
int | stringSizeIn, | ||
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get Filter Name.
[out] | pFilterNameOut | filter name |
[in] | stringSizeIn | number of characters pFilterNameOut can hold |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getParentId | ( | FilterID * | pParentFilterIdOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get Filter Parent.
[out] | pParentFilterIdOut | filter parent |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
const WChar* mdlFilter_getPathName | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get Filter Path Name - name of Filter appended by names of all its parents.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getPersistent | ( | bool * | pbPersistentOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get if a Filter is persistent.
[out] | pbPersistentOut | persistent flag |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
StatusInt mdlFilter_getType | ( | UShort * | pFilterTypeOut, |
DgnModelRefP | pModelRefIn, | ||
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Get Filter Type.
[out] | pFilterTypeOut | filter type |
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
bool mdlFilter_hasMember | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
FilterMemberID | iMemberIdIn | ||
) |
Check if filter has specified member.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
[in] | iMemberIdIn | member id |
bool mdlFilter_isChild | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Check if a filter is a child.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
bool mdlFilter_isExternal | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Check if a Filter is external.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
bool mdlFilter_isParent | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Check if a filter is a parent.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
bool mdlFilter_isPersistent | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Check if a Filter is persistent.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
bool mdlFilter_isValid | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn | ||
) |
Check if filter id is valid.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
bool mdlFilter_isValidByName | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iParentFilterIdIn, | ||
WCharCP | pFilterNameIn | ||
) |
Check if a filter with specified name is valid.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iParentFilterIdIn | parent filter id |
[in] | pFilterNameIn | filter name |
StatusInt mdlFilter_setActive | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iActiveFilterIdIn | ||
) |
Set the active filter.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iActiveFilterIdIn | active filter id |
StatusInt mdlFilter_setComposeExpression | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
WCharCP | pComposeExpressionStringIn | ||
) |
Filter may be composed of other filters.
This provides a way to compose filters using the standard set operators. The composition is expressed in the form of a string, such as "F3 | F2 - F4"
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
[in] | pComposeExpressionStringIn | compose expression string - maybe NULL |
StatusInt mdlFilter_setDescription | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
WCharCP | pDescriptionIn | ||
) |
Set filter name.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | id of filter to delete |
[in] | pDescriptionIn | filter description - may be NULL |
StatusInt mdlFilter_setName | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
WCharCP | pNameIn | ||
) |
Set filter name.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | id of filter to delete |
[in] | pNameIn | filter name |
StatusInt mdlFilter_setParentId | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
FilterID | parentFilterIdIn | ||
) |
Set Filter Parent.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
[in] | parentFilterIdIn | filter parent |
StatusInt mdlFilter_setPersistent | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
bool | bPersistentIn | ||
) |
Set if a Filter is persistent.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
[in] | bPersistentIn | persistent flag |
StatusInt mdlFilter_setType | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn, | ||
FilterID | iFilterIdIn, | ||
UShort | filterTypeIn | ||
) |
Set Filter Type.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
[in] | iFilterIdIn | filter id |
[in] | filterTypeIn | filter type |
StatusInt mdlFilterError_getMessage | ( | WChar * | pErrorMessageOut, |
int | stringSizeIn, | ||
int | errorStatusIn | ||
) |
Get a message string describing a returned filter-error status.
[out] | pErrorMessageOut | error message |
[in] | stringSizeIn | number of characters pErrorMessageOut can hold |
[in] | errorStatusIn | error status for which a message string is required |
StatusInt mdlFilterError_outputToMessageCenter | ( | DgnPlatform::OutputMessagePriority | errorMessagePriorityIn, |
int | errorStatusIn | ||
) |
Output to the message center a message string describing a returned filter-error status.
[in] | errorMessagePriorityIn | error message type. One of MESSAGE_.. types - defined in msdefs.h |
[in] | errorStatusIn | error status for which a message string is required |
FilterIteratorP mdlFilterIterator_create | ( | DgnModelRefP | pModelRefIn, |
WCharCP | pFilterTableNameIn | ||
) |
Create a new filter iterator to iterate thru' filters.
[in] | pModelRefIn | model ref |
[in] | pFilterTableNameIn | filter table name |
void mdlFilterIterator_free | ( | FilterIteratorP * | ppFilterIteratorIn | ) |
Free a filter iterator which is not required.
[in] | ppFilterIteratorIn | filter iterator to free |
FilterID mdlFilterIterator_getFirst | ( | FilterIteratorP | pFilterIteratorIn | ) |
Get first filter.
[in] | pFilterIteratorIn | filter iterator |
FilterID mdlFilterIterator_getLast | ( | FilterIteratorP | pFilterIteratorIn | ) |
Get last filter.
[in] | pFilterIteratorIn | filter iterator |
FilterID mdlFilterIterator_getNext | ( | FilterIteratorP | pFilterIteratorIn | ) |
Get next filter.
[in] | pFilterIteratorIn | filter iterator |
FilterID mdlFilterIterator_getPrevious | ( | FilterIteratorP | pFilterIteratorIn | ) |
Get previous filter.
[in] | pFilterIteratorIn | filter iterator |
StatusInt mdlFilterIterator_reset | ( | FilterIteratorP | pFilterIteratorIn | ) |
Reset the iteration process to restart from the beginning.
[in] | pFilterIteratorIn | filter iterator |
StatusInt mdlFilterIterator_setFilterTable | ( | FilterIteratorP | pFilterIteratorIn, |
WCharCP | pFilterTableNameIn | ||
) |
Set filter table on whose filters to iterate.
[in] | pFilterIteratorIn | filter iterator |
[in] | pFilterTableNameIn | filter table, whose filters to iterate |
StatusInt mdlFilterIterator_setIterateOrder | ( | FilterIteratorP | pFilterIteratorIn, |
UInt | iterateOrderIn | ||
) |
Set iteration order - by id or by name.
[in] | pFilterIteratorIn | filter iterator |
[in] | iterateOrderIn | one of FILTER_ITERATE_ORDER_... (defined in filtertable.h) |
StatusInt mdlFilterIterator_setIterateType | ( | FilterIteratorP | pFilterIteratorIn, |
UInt | iterateTypeIn | ||
) |
Set iteration type.
[in] | pFilterIteratorIn | filter iterator |
[in] | iterateTypeIn | one of FILTER_ITERATE_TYPE_... (defined in filtertable.h) |
StatusInt mdlFilterIterator_setModelRef | ( | FilterIteratorP | pFilterIteratorIn, |
DgnModelRefP | pModelRefIn | ||
) |
Set model ref on whose filters to iterate.
[in] | pFilterIteratorIn | filter iterator |
[in] | pModelRefIn | model ref, whose filters to iterate |
StatusInt mdlFilterIterator_setParentFilterId | ( | FilterIteratorP | pFilterIteratorIn, |
FilterID | iParentFilterIdIn | ||
) |
Set parent filter-id, whose children are to be iterated on.
This sets the iteration type to FILTER_ITERATE_TYPE_CHILDREN.
[in] | pFilterIteratorIn | filter iterator |
[in] | iParentFilterIdIn | parent filter id |
StatusInt mdlFilterIterator_traverse | ( | FilterIteratorP | pFilterIteratorIn, |
FilterIteratorTraverseCallback | pUserFunctionIn, | ||
CallbackArgP | pUserArgIn | ||
) |
Traverse through all filter entries as specified in the iterator.
The call-back function is called for each filter-entry.
[in] | pFilterIteratorIn | filter iterator |
[in] | pUserFunctionIn | User call-back function |
[in] | pUserArgIn | user argument |
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.
[out] | ppFilterLibraryDescrOut | filter library descr |
[out] | pLibraryFormatOut | library format of file |
[in] | pFilterTableNameIn | name of filter-table to import |
[in] | pFileNameIn | name of library to import |
[in] | libraryFormatIn | format of file - one of FILTER_LIBRARY_FORMAT_ ... (defined in filtertable.h) |
int mdlFilterLibrary_import | ( | WCharCP | pFilterTableNameIn, |
WCharCP | pFileNameIn, | ||
FilterLibraryFormat | libraryFormatIn | ||
) |
Import filter-library into the current-file.
This function copies all the filters of specified filter-table into the current-file.
[in] | pFilterTableNameIn | name of filter-table to import |
[in] | pFileNameIn | name of library to import |
[in] | libraryFormatIn | format of file - one of FILTER_LIBRARY_FORMAT_ ... (defined in filtertable.h) |
void mdlFilterName_getInvalidCharacters | ( | const WChar ** | pInvalidCharactersOut | ) |
Get the list of Invalid characters.
[out] | pInvalidCharactersOut | Invalid characters list |
bool mdlFilterName_hasValidCharacters | ( | const WChar * | pNameStringIn | ) |
Check if specified Name String is valid.
[in] | pNameStringIn | filter name |
void mdlFilterName_replaceInvalidCharacters | ( | WChar * | pNameStringIn, |
WChar | replacementCharIn | ||
) |
Replace all invalid characters in specified Name String with another
character
[in] | pNameStringIn | filter name |
[in] | replacementCharIn | replacement character |
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.
[out] | pPassFlagOut | true if the value passes the filter member, else false |
[in] | expressionTypeIn | type of expression (currently unused) |
[in] | pBooleanExpressionIn | boolean expression |
[in] | booleanValueIn | boolean value to test against boolean expression. |
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.
[out] | pPassFlagOut | true if the value passes the filter member, else false |
[in] | expressionTypeIn | type of expression (currently unused) |
[in] | pDoubleExpressionIn | double expression |
[in] | doubleValueIn | double value to test against double expression. |
StatusInt mdlFilterValue_applyIntegerExpression | ( | bool * | pPassFlagOut, |
UShort | expressionTypeIn, | ||
WCharCP | pIntegerExpressionIn, | ||
int | integerValueIn | ||
) |
Check if integer value passes integer expression.
Integer Expression | Integer values that pass Expression |
---|---|
1,10 | Matches integers 1,10 |
10,15-20 | Matches integers 10, 15, 16, 17, 18, 19 20 |
<20 | Matches all integers less than 20 |
>10, <20 | Matches all integers greater than 10 or less than 20 |
!=20 | Matches all integers not equal to 20 |
[out] | pPassFlagOut | true if the value passes the filter member, else false |
[in] | expressionTypeIn | type of expression (currently unused) |
[in] | pIntegerExpressionIn | integer expression |
[in] | integerValueIn | integer value to test against integer expression. |
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.
expressionTypeIn | Description |
---|---|
FILTER_STRING_EXPRESSION_TYPE_REGULAR | The expression is a regular expression |
FILTER_STRING_EXPRESSION_TYPE_DOS | The expression is of the form supported on a DOS command line (such as in the dir command) |
FILTER_STRING_EXPRESSION_TYPE_FIND | The expression is of the form supported in the MS-Windows Explorer Search Dialog |
To explain how String Expressions work, turn on "Filters" in the level manager & type in an expression under the "Name" column of the levelmanager:
Expression | Level Names which are matched |
---|---|
lev | All levels which have the sub-string "lev" |
"lev" | The level with the name "lev" |
*1 | All levels which end with 1. |
lev* | All levels which start with the sub-string lev. |
1 | 2 | All levels which have the character 1 or 2. |
1 & 2 | All levels which have the character 1 and 2. |
1 - 2 | All levels which have the character 1 but not the character 2. |
The '|', '&' and '-' set operators can be combined in more complex ways as follows:
Expression | Level Names which are matched |
---|---|
*1 | *2 | *3 | All levels which end with 1 or which end with 2 or which end with 3 |
((1 | 2) - 3) | All levels which have the characters 1 or 2, but do not have the character 3 |
"level 1" | "level 2" | Matches exactly 2 levels - levels with name "level 1"/"level 2" |
[out] | pPassFlagOut | true if the value passes the filter member, else false |
[in] | expressionTypeIn | type of expression - one of FILTER_STRG_EXPRESSION_TYPE... (defined in filtertable.h) |
[in] | pStringExpressionIn | string expression |
[in] | pStringValueIn | string to test against string expression. |
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.
[out] | pbChangeOut | true if pRemappedExpressionOut is different from pIntegerExpressionIn |
[out] | pRemappedExpressionOut | string for the expression with remapped integers |
[in] | pIntegerExpressionIn | source integer expression |
[in] | pOriginalIntegerArrayIn | array to original integers |
[in] | pRemapIntegerArrayIn | array to integers to remap to |
[in] | numIntegersIn | number of ids in arrays above |