Public Types | Public Member Functions | List of all members
HandlerId Struct Reference

A two-part identifier, consisting of a major ID and a minor ID. More...

#include <DgnCore.h>

Inheritance diagram for HandlerId:
DgnModelHandlerId DisplayFilterHandlerId ElementHandlerId ParameterExpressionHandlerId XAttributeHandlerId

Public Types

enum  { INVALID_ID =0 }
 

Public Member Functions

 HandlerId ()
 
 HandlerId (UInt16 major, UInt16 minor)
 Define a handler Id. More...
 
UInt32 GetId () const
 Gets the full 32-bit ID. More...
 
UInt16 GetMajorId () const
 Gets the major ID portion of the HandlerId. More...
 
UInt16 GetMinorId () const
 Gets the minor ID portion of the HandlerID. More...
 
bool operator== (HandlerId const &other) const
 Test two HandlerIds for equality. More...
 
bool operator!= (HandlerId const &other) const
 Test two HandlerIds for inequality. More...
 
bool operator< (HandlerId const &other) const
 Test two HandlerIds for relative value. More...
 
bool IsValid () const
 Test if the HandlerId has a non-zero major Id portion. More...
 

Detailed Description

A two-part identifier, consisting of a major ID and a minor ID.

The major Id is similar to a LINKAGEID, and must be issued by Bentley Systems. The minor Id is chosen by the handler implementer.

Member Enumeration Documentation

anonymous enum
Enumerator
INVALID_ID 

Constructor & Destructor Documentation

HandlerId ( )
HandlerId ( UInt16  major,
UInt16  minor 
)

Define a handler Id.

Parameters
[in]majorThe major part of the HandlerID - must be issued by Bentley Systems.
[in]minorThe minor part of the HandlerID - chosen by handler implementer.

Member Function Documentation

UInt32 GetId ( ) const

Gets the full 32-bit ID.

UInt16 GetMajorId ( ) const

Gets the major ID portion of the HandlerId.

UInt16 GetMinorId ( ) const

Gets the minor ID portion of the HandlerID.

bool IsValid ( ) const

Test if the HandlerId has a non-zero major Id portion.

bool operator!= ( HandlerId const &  other) const

Test two HandlerIds for inequality.

bool operator< ( HandlerId const &  other) const

Test two HandlerIds for relative value.

bool operator== ( HandlerId const &  other) const

Test two HandlerIds for equality.


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

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