CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
AECStairStringerCompDef Class Reference

#include <AECStairStringerCompDef.h>

Inheritance diagram for AECStairStringerCompDef:
AECStairCompDef AECImpObj OdRxObjectImpl< OdRxObject, AECImpObj > OdRxObject

Public Types

enum  StringerType { eSaddled = 1 , eHoused = 2 , eSlab = 3 , eRamp = 4 }
 
enum  AlignmentType { eLeft = 1 , eRight = 2 , eCenter = 3 , eJustify = 4 }
 
enum  CleanupType { eCleanup = 0 , eTruncate = 1 }
 

Public Member Functions

const OdStringGetName () const
 
void SetName (const OdString &strName)
 
StringerType GetStringerType () const
 
void SetStringerType (StringerType eType)
 
AlignmentType GetAlignmentType () const
 
void SetAlignmentType (AlignmentType eType)
 
CleanupType GetCleanupType () const
 
void SetCleanupType (CleanupType eType)
 
double GetOffset () const
 
void SetOffset (double dOffset)
 
double GetWidth () const
 
void SetWidth (double dWidth)
 
double GetFlightWaist () const
 
void SetFlightWaist (double dWaist)
 
double GetFlightTotal () const
 
void SetFlightTotal (double dTotal)
 
double GetLandingWaist () const
 
void SetLandingWaist (double dWaist)
 
double GetLandingTotal () const
 
void SetLandingTotal (double dTotal)
 
const OdDbObjectIdGetMaterial () const
 
void SetMaterial (const OdDbObjectId &id)
 
- Public Member Functions inherited from AECStairCompDef
OdUInt16 GetIndex () const
 
void SetIndex (OdUInt16 iIndex)
 
- Public Member Functions inherited from AECImpObj
const OdStringGetDescription () const
 
void SetDescription (const OdString &strDescription)
 
virtual void onObjectLoaded ()
 
virtual void SubClose ()
 DOM.
 
OdRxObjectGetOwner () const
 
OdRxObjectGetOwner (OdRxClass *pClass) const
 
void addRefSubPtr ()
 
void releaseSubPtr ()
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
OdDbDatabasedatabase () const
 
void copyFrom (const OdRxObject *pOther)
 
virtual OdUInt16 minSupportedVersion () const
 
void SetOwner (OdDbObject *pOwner)
 DOM.
 
void SetOwner (AECImpObj *pOwner)
 DOM.
 
class AECSIBase * GetImpl () const
 DOM.
 
virtual OdResult dwgInFieldsEx20 (AECDbDwgFiler *pFiler)
 DOM.
 
virtual OdResult dwgInFieldsEx1 (AECDbDwgFiler *pFiler)
 DOM.
 
- Public Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
 OdRxObjectImpl ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
- 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
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Attributes

OdString m_strName
 
AlignmentType m_uAlignment
 
double m_dOffset
 
double m_dWidth
 
StringerType m_uType
 
double m_dFlightTotal
 
double m_dFlightWaist
 
double m_dLandingTotal
 
double m_dLandingWaist
 
OdDbHardPointerId m_hpidMaterial
 
CleanupType m_eCleanup
 
- Protected Attributes inherited from AECStairCompDef
OdUInt16 m_iIndex
 
- Protected Attributes inherited from AECImpObj
class AECSIBase * m_pImp
 DOM.
 
OdUInt16 m_iMinSupportedVersion
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
static OdSmartPtr< AECImpObjcreateObject ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
 ODRX_HEAP_OPERATORS ()
 

Detailed Description

Stair Stringer Component Definition.

<group TA_API_Subobjects_Stair>

Definition at line 34 of file AECStairStringerCompDef.h.

Member Enumeration Documentation

◆ AlignmentType

Types of alignment of stringers.

Remarks
eJustify is called 'Full Width' since version 40. And it is the only choice for ramp and slab types.
Enumerator
eLeft 
eRight 
eCenter 
eJustify 

Definition at line 60 of file AECStairStringerCompDef.h.

◆ CleanupType

Possible cleanup types.

Enumerator
eCleanup 
eTruncate 

Definition at line 71 of file AECStairStringerCompDef.h.

◆ StringerType

Possible types of stringer.

Remarks
eSlab and eRamp appears since version 40.
Enumerator
eSaddled 
eHoused 
eSlab 
eRamp 

Definition at line 45 of file AECStairStringerCompDef.h.

Member Function Documentation

◆ GetAlignmentType()

AlignmentType AECStairStringerCompDef::GetAlignmentType ( ) const

Returns alignment type.

◆ GetCleanupType()

CleanupType AECStairStringerCompDef::GetCleanupType ( ) const

Returns cleanup type.

◆ GetFlightTotal()

double AECStairStringerCompDef::GetFlightTotal ( ) const

Returns flight total value.

◆ GetFlightWaist()

double AECStairStringerCompDef::GetFlightWaist ( ) const

Returns flight waist value.

◆ GetLandingTotal()

double AECStairStringerCompDef::GetLandingTotal ( ) const

Returns landing total value.

◆ GetLandingWaist()

double AECStairStringerCompDef::GetLandingWaist ( ) const

Returns landing waist value.

◆ GetMaterial()

const OdDbObjectId & AECStairStringerCompDef::GetMaterial ( ) const

Returns the Object ID of the material definition (AECDbMaterialDef) for this component.

Remarks
Since version 40.

◆ GetName()

const OdString & AECStairStringerCompDef::GetName ( ) const

Returns stringer name.

◆ GetOffset()

double AECStairStringerCompDef::GetOffset ( ) const

Returns stringer offset.

◆ GetStringerType()

StringerType AECStairStringerCompDef::GetStringerType ( ) const

Returns stringer type.

◆ GetWidth()

double AECStairStringerCompDef::GetWidth ( ) const

Returns stringer width.

◆ SetAlignmentType()

void AECStairStringerCompDef::SetAlignmentType ( AlignmentType  eType)

Sets alignment type.

◆ SetCleanupType()

void AECStairStringerCompDef::SetCleanupType ( CleanupType  eType)

Sets cleanup type.

◆ SetFlightTotal()

void AECStairStringerCompDef::SetFlightTotal ( double  dTotal)

Sets flight total value.

◆ SetFlightWaist()

void AECStairStringerCompDef::SetFlightWaist ( double  dWaist)

Sets flight waist value.

◆ SetLandingTotal()

void AECStairStringerCompDef::SetLandingTotal ( double  dTotal)

Sets landing total value.

◆ SetLandingWaist()

void AECStairStringerCompDef::SetLandingWaist ( double  dWaist)

Sets landing waist value.

◆ SetMaterial()

void AECStairStringerCompDef::SetMaterial ( const OdDbObjectId id)

Sets the Object ID of the material definition (AECDbMaterialDef) for this component.

Remarks
Since version 40.

◆ SetName()

void AECStairStringerCompDef::SetName ( const OdString strName)

Sets stringer name.

◆ SetOffset()

void AECStairStringerCompDef::SetOffset ( double  dOffset)

Sets stringer offset.

◆ SetStringerType()

void AECStairStringerCompDef::SetStringerType ( StringerType  eType)

Sets stringer type.

◆ SetWidth()

void AECStairStringerCompDef::SetWidth ( double  dWidth)

Sets stringer width.

Member Data Documentation

◆ m_dFlightTotal

double AECStairStringerCompDef::m_dFlightTotal
protected

Definition at line 213 of file AECStairStringerCompDef.h.

◆ m_dFlightWaist

double AECStairStringerCompDef::m_dFlightWaist
protected

Definition at line 216 of file AECStairStringerCompDef.h.

◆ m_dLandingTotal

double AECStairStringerCompDef::m_dLandingTotal
protected

Definition at line 219 of file AECStairStringerCompDef.h.

◆ m_dLandingWaist

double AECStairStringerCompDef::m_dLandingWaist
protected

Definition at line 222 of file AECStairStringerCompDef.h.

◆ m_dOffset

double AECStairStringerCompDef::m_dOffset
protected

Definition at line 204 of file AECStairStringerCompDef.h.

◆ m_dWidth

double AECStairStringerCompDef::m_dWidth
protected

Definition at line 207 of file AECStairStringerCompDef.h.

◆ m_eCleanup

CleanupType AECStairStringerCompDef::m_eCleanup
protected

Definition at line 228 of file AECStairStringerCompDef.h.

◆ m_hpidMaterial

OdDbHardPointerId AECStairStringerCompDef::m_hpidMaterial
protected

Definition at line 225 of file AECStairStringerCompDef.h.

◆ m_strName

OdString AECStairStringerCompDef::m_strName
protected

Definition at line 198 of file AECStairStringerCompDef.h.

◆ m_uAlignment

AlignmentType AECStairStringerCompDef::m_uAlignment
protected

Definition at line 201 of file AECStairStringerCompDef.h.

◆ m_uType

StringerType AECStairStringerCompDef::m_uType
protected

Definition at line 210 of file AECStairStringerCompDef.h.


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