DgnPlatform/ValueFormat.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once
#include    "DgnFileIO/ModelInfo.h"
#include    "DgnFileIO/UnitDefinition.h"
#include    <Bentley/ValueFormat.h>
#include    <Bentley/DateTime.h>

DGNPLATFORM_TYPEDEFS(AngleFormatter);
DGNPLATFORM_TYPEDEFS(DirectionFormatter);
DGNPLATFORM_TYPEDEFS(DistanceFormatter);
DGNPLATFORM_TYPEDEFS(PointFormatter);
DGNPLATFORM_TYPEDEFS(AreaFormatter);
DGNPLATFORM_TYPEDEFS(VolumeFormatter);
DGNPLATFORM_TYPEDEFS(DateTimeFormatter);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef RefCountedPtr<AngleFormatter>       AngleFormatterPtr;
typedef RefCountedPtr<DirectionFormatter>   DirectionFormatterPtr;
typedef RefCountedPtr<DistanceFormatter>    DistanceFormatterPtr;
typedef RefCountedPtr<PointFormatter>       PointFormatterPtr;
typedef RefCountedPtr<AreaFormatter>        AreaFormatterPtr;
typedef RefCountedPtr<VolumeFormatter>      VolumeFormatterPtr;
typedef RefCountedPtr<DateTimeFormatter>    DateTimeFormatterPtr;

//=======================================================================================
//=======================================================================================
struct AngleFormatter : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT  AngleMode           GetAngleMode        () const;

    public: DGNPLATFORM_EXPORT  AnglePrecision      GetAnglePrecision   () const;

    public: DGNPLATFORM_EXPORT  WChar               GetDecimalSeparator () const;

    public: DGNPLATFORM_EXPORT  bool                GetLeadingZero      () const;

    public: DGNPLATFORM_EXPORT  bool                GetTrailingZeros    () const;

    public: DGNPLATFORM_EXPORT  bool                GetAllowNegative    () const;

    public: DGNPLATFORM_EXPORT  void                SetAngleMode        (AngleMode newVal);

    public: DGNPLATFORM_EXPORT  void                SetAnglePrecision   (AnglePrecision newVal);

    public: DGNPLATFORM_EXPORT  void                SetDecimalSeparator (WChar newVal);

    public: DGNPLATFORM_EXPORT  void                SetLeadingZero      (bool newVal);

    public: DGNPLATFORM_EXPORT  void                SetTrailingZeros    (bool newVal);

    public: DGNPLATFORM_EXPORT  void                SetAllowNegative    (bool newVal);

public: static DGNPLATFORM_EXPORT AngleFormatterPtr Create();

public: static DGNPLATFORM_EXPORT AngleFormatterPtr Create (DgnModelCR model);

    public: DGNPLATFORM_EXPORT  AngleFormatterPtr   Clone () const;

    public: DGNPLATFORM_EXPORT WString              ToString         (double value) const;

    public: DGNPLATFORM_EXPORT WString              ToStringFromRadians   (double value) const;


}; // AngleFormatter

//=======================================================================================
//=======================================================================================
CLRPUBLIC struct DirectionFormatter : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:

    public:     DGNPLATFORM_EXPORT  AngleFormatterR    GetAngleFormatter ();

    public:     DGNPLATFORM_EXPORT DirectionMode       GetDirectionMode    () const;

    public:     DGNPLATFORM_EXPORT bool                GetAddTrueNorth     () const;

    public:     DGNPLATFORM_EXPORT double              GetTrueNorthValue   () const;

    public:     DGNPLATFORM_EXPORT double              GetBaseDirection    () const;

    public:     DGNPLATFORM_EXPORT bool                GetClockwise        () const;

    public:     DGNPLATFORM_EXPORT bool                GetBearingSpaces    () const;

    public:     DGNPLATFORM_EXPORT  void               SetAngleFormatter (AngleFormatterCR);

    public:     DGNPLATFORM_EXPORT void                SetDirectionMode    (DirectionMode newVal);

    public:     DGNPLATFORM_EXPORT void                SetAddTrueNorth     (bool newVal);

    public:     DGNPLATFORM_EXPORT void                SetTrueNorthValue   (double newVal);

    public:     DGNPLATFORM_EXPORT void                SetBaseDirection    (double newVal);

    public:     DGNPLATFORM_EXPORT void                SetClockwise        (bool newVal);

    public:     DGNPLATFORM_EXPORT void                SetBearingSpaces    (bool newVal);

public: static DGNPLATFORM_EXPORT DirectionFormatterPtr Create();

public: static DGNPLATFORM_EXPORT DirectionFormatterPtr Create (DgnModelCR model);

public: DGNPLATFORM_EXPORT  DirectionFormatterPtr    Clone () const;

    public:     DGNPLATFORM_EXPORT WString       ToString   (double value) const;

    public:     DGNPLATFORM_EXPORT WString       ToStringFromRadians   (double value) const;

}; // DirectionFormatter

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DistanceFormatter : DoubleFormatterBase, RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT  DgnUnitFormat       GetUnitFormat () const;

    public: DGNPLATFORM_EXPORT  UnitDefinitionCR    GetMasterUnit () const;

    public: DGNPLATFORM_EXPORT  UnitDefinitionCR    GetSubUnit () const;

    public: DGNPLATFORM_EXPORT  UnitDefinitionCR    GetStorageUnit () const;

    public: DGNPLATFORM_EXPORT  double              GetUorPerStorageUnit () const;

    public: DGNPLATFORM_EXPORT  double              GetScaleFactor () const;

    public: DGNPLATFORM_EXPORT  bool                GetUnitLabelFlag () const;

    public: DGNPLATFORM_EXPORT  bool                GetSuppressZeroMasterUnits () const;

    public: DGNPLATFORM_EXPORT  bool                GetSuppressZeroSubUnits () const;

    public: DGNPLATFORM_EXPORT  bool                GetIsDgnCoordReadOutCapable () const;

    public: DGNPLATFORM_EXPORT  double              GetMinimumResolution () const;

    public: DGNPLATFORM_EXPORT  void                SetUnitFormat (DgnUnitFormat newVal);

    public: DGNPLATFORM_EXPORT  StatusInt           SetWorkingUnits (UnitDefinitionCR newMasterUnit, UnitDefinitionCP newSubUnit);

    public: DGNPLATFORM_EXPORT  void                SetStorageUnit (UnitDefinitionCR newStorageUnit, double uorPerStorage);

    public: DGNPLATFORM_EXPORT  void                SetStorageUnit (UnitDefinitionCR newVal);

    public: DGNPLATFORM_EXPORT  void                SetUorPerStorageUnit (double newVal);

    public: DGNPLATFORM_EXPORT  void                SetScaleFactor (double newVal);

    public: DGNPLATFORM_EXPORT  void                SetUnitLabelFlag (bool newVal);

    public: DGNPLATFORM_EXPORT  void                SetSuppressZeroMasterUnits (bool newVal);

    public: DGNPLATFORM_EXPORT  void                SetSuppressZeroSubUnits (bool newVal);

    public: DGNPLATFORM_EXPORT  void                SetIsDgnCoordReadOutCapable (bool newVal);

public: static DGNPLATFORM_EXPORT  DistanceFormatterPtr     Create ();

public: static DGNPLATFORM_EXPORT  DistanceFormatterPtr     Create (DgnModelCR model);

public: static DGNPLATFORM_EXPORT  DistanceFormatterPtr     Create (ViewportR vp);

    public: DGNPLATFORM_EXPORT  DistanceFormatterPtr    Clone () const;

    public: DGNPLATFORM_EXPORT WString              ToString (double uors) const;

}; // DistanceFormatter

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct PointFormatter : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT  DistanceFormatterR  GetDistanceFormatter ();

    public: DGNPLATFORM_EXPORT  IAuxCoordSysR   GetAuxCoordSys ();

    public: DGNPLATFORM_EXPORT  bool            GetIs3d () const;

    public: DGNPLATFORM_EXPORT  void            SetDistanceFormatter (DistanceFormatterCR);

    public: DGNPLATFORM_EXPORT  void            SetAuxCoordSys (IAuxCoordSysCR);

    public: DGNPLATFORM_EXPORT  void            SetIs3d (bool newVal);

public: static DGNPLATFORM_EXPORT  PointFormatterPtr    Create ();

public: static DGNPLATFORM_EXPORT  PointFormatterPtr    Create (DgnModelCR model, bool addGlobalOrigin);

public: static DGNPLATFORM_EXPORT  PointFormatterPtr    Create (ViewportR vp);

public: static DGNPLATFORM_EXPORT  PointFormatterPtr    Create (DistanceFormatterCR distanceFormatter);

    public: DGNPLATFORM_EXPORT  PointFormatterPtr    Clone () const;

    public: DGNPLATFORM_EXPORT WString      ToString (DPoint3dCR point) const;

}; // PointFormatter

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct AreaOrVolumeFormatterBase : DoubleFormatterBase
{
private:
AreaOrVolumeFormatterBase ();

    public: DGNPLATFORM_EXPORT  UnitDefinitionCR    GetMasterUnit () const;

    public: DGNPLATFORM_EXPORT  UnitDefinitionCR    GetStorageUnit () const;

    public: DGNPLATFORM_EXPORT  double              GetUorPerStorageUnit () const;

    public: DGNPLATFORM_EXPORT  double              GetScaleFactor () const;

    public: DGNPLATFORM_EXPORT  bool                GetShowUnitLabel () const;

    public: DGNPLATFORM_EXPORT  bool                GetLabelDecoratorAsSuffix () const;

    public: DGNPLATFORM_EXPORT  StatusInt           SetMasterUnit (UnitDefinitionCR newUnit);

    public: DGNPLATFORM_EXPORT  void                SetStorageUnit (UnitDefinitionCR newStorageUnit, double uorPerStorage);

    public: DGNPLATFORM_EXPORT  void                SetStorageUnit (UnitDefinitionCR newVal);

    public: DGNPLATFORM_EXPORT  void                SetUorPerStorageUnit (double newVal);

    public: DGNPLATFORM_EXPORT  void                SetScaleFactor (double newVal);

    public: DGNPLATFORM_EXPORT  void                SetShowUnitLabel (bool newVal);

    public: DGNPLATFORM_EXPORT  void                SetLabelDecoratorAsSuffix (bool newVal);
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct AreaFormatter : AreaOrVolumeFormatterBase, RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:

public: static DGNPLATFORM_EXPORT  AreaFormatterPtr     Create ();

public: static DGNPLATFORM_EXPORT  AreaFormatterPtr     Create (DgnModelCR model);

public: static DGNPLATFORM_EXPORT  AreaFormatterPtr     Create (ViewportR vp);

    public: DGNPLATFORM_EXPORT  AreaFormatterPtr    Clone () const;

    public: DGNPLATFORM_EXPORT WString              ToString (double uors) const;

}; // AreaFormatter

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct VolumeFormatter : AreaOrVolumeFormatterBase, RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:

public: static DGNPLATFORM_EXPORT  VolumeFormatterPtr     Create ();

public: static DGNPLATFORM_EXPORT  VolumeFormatterPtr     Create (DgnModelCR model);

public: static DGNPLATFORM_EXPORT  VolumeFormatterPtr     Create (ViewportR vp);

public: DGNPLATFORM_EXPORT  VolumeFormatterPtr    Clone () const;

public: DGNPLATFORM_EXPORT WString              ToString (double uors) const;

}; // VolumeFormatter

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct DateTimeFormatter : RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
    DGNPLATFORM_EXPORT WChar                           GetDecimalSeparator() const;
    DGNPLATFORM_EXPORT WChar                           GetTimeSeparator() const;
    DGNPLATFORM_EXPORT WChar                           GetDateSeparator() const;
    DGNPLATFORM_EXPORT UInt8                           GetFractionalSecondPrecision() const;
    DGNPLATFORM_EXPORT bool                            GetTrailingZeros() const;

    DGNPLATFORM_EXPORT void                            SetDecimalSeparator (WChar separator);
    DGNPLATFORM_EXPORT void                            SetTimeSeparator (WChar separator);
    DGNPLATFORM_EXPORT void                            SetDateSeparator (WChar separator);
    DGNPLATFORM_EXPORT void                            SetFractionalSecondPrecision (UInt8 precision);
    DGNPLATFORM_EXPORT void                            SetTrailingZeros (bool show);

    DGNPLATFORM_EXPORT void                            AppendFormatPart (DateTimeFormatPart part);
    DGNPLATFORM_EXPORT void                            ClearFormatParts();
    DGNPLATFORM_EXPORT void                            Reset();

    static DGNPLATFORM_EXPORT DateTimeFormatterPtr     Create();
    DGNPLATFORM_EXPORT DateTimeFormatterPtr            Clone() const;
    DGNPLATFORM_EXPORT WString                         ToString(DateTimeCR dateTime) const;
    }; // DateTimeFormatter 

END_BENTLEY_DGNPLATFORM_NAMESPACE