Public Member Functions | Static Public Member Functions | List of all members
RevisionNumber Class Reference

A history revision number. More...

#include <DgnHistory.h>

Public Member Functions

DGNPLATFORM_EXPORT ~RevisionNumber ()
 
DGNPLATFORM_EXPORT RevisionNumber ()
 
DGNPLATFORM_EXPORT RevisionNumber (RevisionNumber const &r2)
 
DGNPLATFORM_EXPORT RevisionNumberoperator= (RevisionNumber const &r2)
 
DGNPLATFORM_EXPORT bool operator< (RevisionNumber const &rn2) const
 
DGNPLATFORM_EXPORT bool operator<= (RevisionNumber const &rn2) const
 
DGNPLATFORM_EXPORT bool operator> (RevisionNumber const &rn2) const
 
DGNPLATFORM_EXPORT bool operator>= (RevisionNumber const &rn2) const
 
DGNPLATFORM_EXPORT bool operator== (RevisionNumber const &rn2) const
 
DGNPLATFORM_EXPORT bool operator!= (RevisionNumber const &rn2) const
 
DGNPLATFORM_EXPORT bool IsRecent () const
 Query if this represents "recent changes". More...
 
DGNPLATFORM_EXPORT bool IsValid () const
 Query if this is a valid revision number. More...
 
DGNPLATFORM_EXPORT WString Format () const
 Format a history revision number using the default n.m format. More...
 
DGNPLATFORM_EXPORT WString FormatCustom (WChar const *fmt) const
 Format a history revision number according to the specified format. More...
 

Static Public Member Functions

static DGNPLATFORM_EXPORT
RevisionNumber 
Recent ()
 Get the special RevisionNumber that indicates "recent changes". More...
 
static DGNPLATFORM_EXPORT
RevisionNumber 
ParseCustom (WChar const *fmt, WChar const *str)
 Construct a revision number from a string entered according to a custom format. More...
 
static DGNPLATFORM_EXPORT
RevisionNumber 
Parse (WChar const *str)
 Construct a revision number from a string entered according to the default n.m format. More...
 

Detailed Description

A history revision number.

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

Constructor & Destructor Documentation

Member Function Documentation

DGNPLATFORM_EXPORT WString Format ( ) const

Format a history revision number using the default n.m format.

Returns
formatted string
See also
FormatCustom
DGNPLATFORM_EXPORT WString FormatCustom ( WChar const *  fmt) const

Format a history revision number according to the specified format.

Parameters
[in]fmtThe format specifier.
Returns
formatted string
See also
Format, ParseCustom
Parameters
fmtIN the custom format specifier
DGNPLATFORM_EXPORT bool IsRecent ( ) const

Query if this represents "recent changes".

See also
Recent
DGNPLATFORM_EXPORT bool IsValid ( ) const

Query if this is a valid revision number.

DGNPLATFORM_EXPORT bool operator!= ( RevisionNumber const &  rn2) const
DGNPLATFORM_EXPORT bool operator< ( RevisionNumber const &  rn2) const
DGNPLATFORM_EXPORT bool operator<= ( RevisionNumber const &  rn2) const
DGNPLATFORM_EXPORT RevisionNumber& operator= ( RevisionNumber const &  r2)
DGNPLATFORM_EXPORT bool operator== ( RevisionNumber const &  rn2) const
DGNPLATFORM_EXPORT bool operator> ( RevisionNumber const &  rn2) const
DGNPLATFORM_EXPORT bool operator>= ( RevisionNumber const &  rn2) const
static DGNPLATFORM_EXPORT RevisionNumber Parse ( WChar const *  str)
static

Construct a revision number from a string entered according to the default n.m format.

Parameters
strIN the string to parse
See also
FormatCustom
static DGNPLATFORM_EXPORT RevisionNumber ParseCustom ( WChar const *  fmt,
WChar const *  str 
)
static

Construct a revision number from a string entered according to a custom format.

Parameters
fmtIN the custom format specifier
strIN the string to parse
See also
FormatCustom
static DGNPLATFORM_EXPORT RevisionNumber Recent ( )
static

Get the special RevisionNumber that indicates "recent changes".

See also
IsRecent

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

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