CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
AECDbScheduleDataFormat Class Reference

#include <AECDbScheduleDataFormat.h>

Inheritance diagram for AECDbScheduleDataFormat:
AECDbDictRecord AECDbObject OdDbObject OdGiDrawable OdRxObject

Public Member Functions

const OdStringGetPrefix () const
 
void SetPrefix (const OdString &strPrefix)
 
const OdStringGetSuffix () const
 
void SetSuffix (const OdString &strSuffix)
 
AECDefs::ScheduleCase GetCase () const
 
void SetCase (AECDefs::ScheduleCase eScheduleCase)
 
OdDbUnitsFormatter::LUnits GetUnitFormat () const
 
void SetUnitFormat (OdDbUnitsFormatter::LUnits eAECLinearUnits)
 
OdInt16 GetPrecision () const
 
void SetPrecision (OdInt16 iPrecision)
 
AECDefs::ScheduleSeparator GetDecimalSeparator () const
 
void SetDecimalSeparator (AECDefs::ScheduleSeparator eDecimalSeparator)
 
AECDefs::ScheduleFractionFormat GetFractionFormat () const
 
void SetFractionFormat (AECDefs::ScheduleFractionFormat eFractionFormat)
 
bool IsSuppressLeadingZeros () const
 
void SetIsSuppressLeadingZeros (bool bIsSuppressLeadingZeros)
 
bool IsSuppressTrailingZeros () const
 
void SetIsSuppressTrailingZeros (bool bIsSuppressTrailingZeros)
 
bool IsSuppress0Feet () const
 
void SetIsSuppress0Feet (bool bIsSuppress0Feet)
 
bool IsSuppress0Inches () const
 
void SetIsSuppress0Inches (bool bIsSuppress0Inches)
 
double GetRoundOff () const
 
void SetRoundOff (double dRoundOff)
 
OdInt16 GetZeroPadding () const
 
void SetZeroPadding (OdInt16 iZeroPadding)
 
const OdStringGetUndefinedSymbol () const
 
void SetUndefinedSymbol (const OdString &strUndefinedSymbol)
 
const OdStringGetTrueText () const
 
void SetTrueText (const OdString &strTrueText)
 
const OdStringGetFalseText () const
 
void SetFalseText (const OdString &strFalseText)
 
AECDefs::ScheduleSeparator GetWholeNumberSeparator () const
 
void SetWholeNumberSeparator (AECDefs::ScheduleSeparator eWholeNumberSeparator)
 
AECDefs::ScheduleRoundOffType GetRoundOffType () const
 
void SetRoundOffType (AECDefs::ScheduleRoundOffType eRoundOffType)
 
double GetScale () const
 
void SetScale (double dScale)
 
const OdStringGetNotApplicable () const
 
void SetNotApplicable (const OdString &strNotApplicable)
 
OdString Format (const AECVariant &vValue) const
 
- Public Member Functions inherited from AECDbDictRecord
const OdStringGetDictRecordDescription () const
 
void SetDictRecordDescription (const OdString &strDescription)
 
AECClassificationArraySubPtr GetClassificationArray () const
 
OdString GetName () const
 
- Public Member Functions inherited from AECDbObject
virtual void subClose ()
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
const OdStringGetDescription () const
 
void SetDescription (const OdString &strDescription)
 
OdUInt32 GetOverrideCount () const
 
AECOverrideSubPtr GetOverrideByIndex (OdUInt32 iIndex) const
 
AECImpArraySubPtr GetOverrides ()
 
OdDbObjectId GetCurrentDispProps (const OdDbObjectId &idDispRep)
 
OdDbObjectId OverrideDispProps (const OdDbObjectId &idDispRep, bool bCopyContents=true)
 
void RemoveDispProps (const OdDbObjectId &idDispRep)
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual OdResult subOpen (OdDb::OpenMode mode)
 
OdResult erase (bool eraseIt=true)
 
virtual OdResult subErase (bool erasing)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
virtual void subHandOverTo (OdDbObject *pNewObject)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
virtual OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFilerundoFiler ()
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void modified (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
virtual void copyFrom (const OdRxObject *pSource)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual OdGiDrawabledrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClasssaveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
virtual OdResult subGetClassID (void *pClsid) const
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from AECDbObject
AECImpObjPtr m_pImpObject
 
AECImpArrayPtr m_pOverrides
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

Schedule Data Format.

<group TA_API_Objects>

Definition at line 37 of file AECDbScheduleDataFormat.h.

Member Function Documentation

◆ Format()

OdString AECDbScheduleDataFormat::Format ( const AECVariant vValue) const

Formats the specified value.

◆ GetCase()

AECDefs::ScheduleCase AECDbScheduleDataFormat::GetCase ( ) const

Returns case type for schedule text.

◆ GetDecimalSeparator()

AECDefs::ScheduleSeparator AECDbScheduleDataFormat::GetDecimalSeparator ( ) const

Returns the type of decimal separator.

◆ GetFalseText()

const OdString& AECDbScheduleDataFormat::GetFalseText ( ) const

Returns text string displayed in place of false boolean value.

◆ GetFractionFormat()

AECDefs::ScheduleFractionFormat AECDbScheduleDataFormat::GetFractionFormat ( ) const

Returns the fraction format.

◆ GetNotApplicable()

const OdString& AECDbScheduleDataFormat::GetNotApplicable ( ) const

Returns not applicable string.

◆ GetPrecision()

OdInt16 AECDbScheduleDataFormat::GetPrecision ( ) const

Returns the precision.

◆ GetPrefix()

const OdString& AECDbScheduleDataFormat::GetPrefix ( ) const

Returns the prefix of schedule text.

◆ GetRoundOff()

double AECDbScheduleDataFormat::GetRoundOff ( ) const

Returns rounding value for floating point numbers.

◆ GetRoundOffType()

AECDefs::ScheduleRoundOffType AECDbScheduleDataFormat::GetRoundOffType ( ) const

Returns rounding off type.

◆ GetScale()

double AECDbScheduleDataFormat::GetScale ( ) const

Returns scaling factor.

◆ GetSuffix()

const OdString& AECDbScheduleDataFormat::GetSuffix ( ) const

Returns the suffix of schedule text.

◆ GetTrueText()

const OdString& AECDbScheduleDataFormat::GetTrueText ( ) const

Returns text string displayed in place of true boolean value.

◆ GetUndefinedSymbol()

const OdString& AECDbScheduleDataFormat::GetUndefinedSymbol ( ) const

Returns text string displayed in place of undefined values.

◆ GetUnitFormat()

OdDbUnitsFormatter::LUnits AECDbScheduleDataFormat::GetUnitFormat ( ) const

Returns linear unit format.

◆ GetWholeNumberSeparator()

AECDefs::ScheduleSeparator AECDbScheduleDataFormat::GetWholeNumberSeparator ( ) const

Returns whole number separator.

◆ GetZeroPadding()

OdInt16 AECDbScheduleDataFormat::GetZeroPadding ( ) const

Returns the expansion of integer values to include leading zeros.

◆ IsSuppress0Feet()

bool AECDbScheduleDataFormat::IsSuppress0Feet ( ) const

Returns whether feet portion is suppressed if value is less than 1 foot.

◆ IsSuppress0Inches()

bool AECDbScheduleDataFormat::IsSuppress0Inches ( ) const

Returns whether inches portion is suppressed if value is integral number of feet.

◆ IsSuppressLeadingZeros()

bool AECDbScheduleDataFormat::IsSuppressLeadingZeros ( ) const

Returns whether leading zeros are suppressed.

◆ IsSuppressTrailingZeros()

bool AECDbScheduleDataFormat::IsSuppressTrailingZeros ( ) const

Returns whether trailing zeros are suppressed.

◆ SetCase()

void AECDbScheduleDataFormat::SetCase ( AECDefs::ScheduleCase  eScheduleCase)

Sets case type for schedule text.

◆ SetDecimalSeparator()

void AECDbScheduleDataFormat::SetDecimalSeparator ( AECDefs::ScheduleSeparator  eDecimalSeparator)

Sets the type of decimal separator.

◆ SetFalseText()

void AECDbScheduleDataFormat::SetFalseText ( const OdString strFalseText)

Sets text string displayed in place of false boolean value.

◆ SetFractionFormat()

void AECDbScheduleDataFormat::SetFractionFormat ( AECDefs::ScheduleFractionFormat  eFractionFormat)

Sets the fraction format.

◆ SetIsSuppress0Feet()

void AECDbScheduleDataFormat::SetIsSuppress0Feet ( bool  bIsSuppress0Feet)

Sets whether feet portion is suppressed if value is less than 1 foot.

◆ SetIsSuppress0Inches()

void AECDbScheduleDataFormat::SetIsSuppress0Inches ( bool  bIsSuppress0Inches)

Sets whether inches portion is suppressed if value is integral number of feet.

◆ SetIsSuppressLeadingZeros()

void AECDbScheduleDataFormat::SetIsSuppressLeadingZeros ( bool  bIsSuppressLeadingZeros)

Sets whether leading zeros are suppressed.

◆ SetIsSuppressTrailingZeros()

void AECDbScheduleDataFormat::SetIsSuppressTrailingZeros ( bool  bIsSuppressTrailingZeros)

Sets whether trailing zeros are suppressed.

◆ SetNotApplicable()

void AECDbScheduleDataFormat::SetNotApplicable ( const OdString strNotApplicable)

Sets not applicable string.

◆ SetPrecision()

void AECDbScheduleDataFormat::SetPrecision ( OdInt16  iPrecision)

Sets the precision.

◆ SetPrefix()

void AECDbScheduleDataFormat::SetPrefix ( const OdString strPrefix)

Sets the prefix of schedule text.

◆ SetRoundOff()

void AECDbScheduleDataFormat::SetRoundOff ( double  dRoundOff)

Sets rounding value for floating point numbers.

◆ SetRoundOffType()

void AECDbScheduleDataFormat::SetRoundOffType ( AECDefs::ScheduleRoundOffType  eRoundOffType)

Sets rounding off type.

◆ SetScale()

void AECDbScheduleDataFormat::SetScale ( double  dScale)

Sets scaling factor.

◆ SetSuffix()

void AECDbScheduleDataFormat::SetSuffix ( const OdString strSuffix)

Sets the suffix of schedule text.

◆ SetTrueText()

void AECDbScheduleDataFormat::SetTrueText ( const OdString strTrueText)

Sets text string displayed in place of true boolean value.

◆ SetUndefinedSymbol()

void AECDbScheduleDataFormat::SetUndefinedSymbol ( const OdString strUndefinedSymbol)

Sets text string displayed in place of undefined values.

◆ SetUnitFormat()

void AECDbScheduleDataFormat::SetUnitFormat ( OdDbUnitsFormatter::LUnits  eAECLinearUnits)

Sets linear unit format.

◆ SetWholeNumberSeparator()

void AECDbScheduleDataFormat::SetWholeNumberSeparator ( AECDefs::ScheduleSeparator  eWholeNumberSeparator)

Sets whole number separator.

◆ SetZeroPadding()

void AECDbScheduleDataFormat::SetZeroPadding ( OdInt16  iZeroPadding)

Sets the expansion of integer values to include leading zeros.


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