OpenLexocad  27.0
Base Namespace Reference

Classes

class  AbortException
 
class  AbstractWriter
 
class  AbstractXMLReader
 
class  AreaDensityUnit
 
class  AreaUnit
 
class  BadArguments
 
class  BaseClass
 BaseClass class and root of the type system. More...
 
class  BaseInit
 
struct  Bool
 
class  Color
 
class  ConstructionError
 
class  CountryTool
 
class  CsvTool
 
struct  Double
 
class  Exception
 
class  Factory
 
class  FailedNotDone
 
class  FileDialog
 
class  FileException
 
class  FileInfo
 
class  GlobalAttachment
 
class  GlobalId
 
class  GlobalId_Policy
 
class  GlobalId_Policy_scoped
 
class  GlobalSave
 
class  GUID
 
class  GUID_Policy
 
class  GUID_Policy_scoped
 
class  GuidInUseException
 
struct  Int
 
class  ItemNotFound
 
class  LengthUnit
 
class  MassDensityUnit
 
class  MassUnit
 
class  MColor
 
class  MemoryException
 
class  MemoryWriter
 
class  MessageBase
 
class  MessageEvent
 
class  MessageInterface
 
class  NotaNumber
 
class  Observer
 
class  OutOfRange
 
class  Persistance
 Persistance class and root of the type system. More...
 
class  PersistanceVersion
 
class  PlaneAngleUnit
 
class  Progress
 
class  ProgressInfo
 
class  ProgressObserver
 
class  PropertyNameTool
 
class  PyHandle
 
class  PyHandler
 
class  Reader
 
class  Rotation
 
class  scopedProfile
 
class  ScopedWaitingSpinner
 
class  SequencerBase
 
class  Sphere
 
class  Stream
 
class  String
 A Utf-16 (windows) or ucs4 (unix) encoded string class. More...
 
class  StringTool
 
class  Subject
 
class  TestRunnerSingleton
 
class  TimeInfo
 
class  timer
 
class  Type
 
class  VectorWithNullMagnitude
 
class  VolumeUnit
 
class  WaitingSpinner
 
class  Writer
 
class  XMLReader
 
class  XMLReaderPUG
 

Typedefs

typedef std::function< void(ProgressInfo)> ProgressHandler
 
typedef std::function< void(int)> SequencerCallBackFunc
 

Enumerations

enum  FillingType { FillingType::NOFILLING, FillingType::WINDOW, FillingType::DOOR }
 
enum  OpeningType {
  OpeningType::WALL, OpeningType::RECTANGLE = 0, OpeningType::TRAPEZOID, OpeningType::ARCHED,
  OpeningType::OCTAGON, OpeningType::TRIANGLE, OpeningType::CIRCLE_WIN, OpeningType::ELLIPSE_WIN,
  OpeningType::SEMICIRCLE, OpeningType::FRENCHWINDOW, OpeningType::DOOR, OpeningType::GARAGEDOOR,
  OpeningType::FLOOR, OpeningType::ROOF, OpeningType::GENERAL, OpeningType::TYPE_FOR_COPY,
  OpeningType::ARCHDOOR, OpeningType::ARCHTOP, OpeningType::PENTAGON, OpeningType::QUARTERCIRCLE,
  OpeningType::TRANSOMDOOR
}
 
enum  PurposeGroup {
  PurposeGroup::DOOR, PurposeGroup::GARAGE, PurposeGroup::FRENCHWINDOW, PurposeGroup::ARCHDOOR,
  PurposeGroup::TRANSOMDOOR
}
 
enum  DoorTypeOperationEnum {
  DoorTypeOperationEnum::SINGLE_SWING_LEFT = 0, DoorTypeOperationEnum::SINGLE_SWING_RIGHT, DoorTypeOperationEnum::DOUBLE_DOOR_SINGLE_SWING, DoorTypeOperationEnum::DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_LEFT,
  DoorTypeOperationEnum::DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_RIGHT, DoorTypeOperationEnum::DOUBLE_SWING_LEFT, DoorTypeOperationEnum::DOUBLE_SWING_RIGHT, DoorTypeOperationEnum::DOUBLE_DOOR_DOUBLE_SWING,
  DoorTypeOperationEnum::SLIDING_TO_LEFT, DoorTypeOperationEnum::SLIDING_TO_RIGHT, DoorTypeOperationEnum::DOUBLE_DOOR_SLIDING, DoorTypeOperationEnum::FOLDING_TO_LEFT,
  DoorTypeOperationEnum::FOLDING_TO_RIGHT, DoorTypeOperationEnum::DOUBLE_DOOR_FOLDING, DoorTypeOperationEnum::REVOLVING, DoorTypeOperationEnum::ROLLINGUP,
  DoorTypeOperationEnum::SWING_FIXED_LEFT, DoorTypeOperationEnum::SWING_FIXED_RIGHT, DoorTypeOperationEnum::USERDEFINED, DoorTypeOperationEnum::NOTDEFINED,
  DoorTypeOperationEnum::INVERT_SINGLE_SWING_RIGHT, DoorTypeOperationEnum::INVERT_SINGLE_SWING_LEFT, DoorTypeOperationEnum::INVERT_SWING_FIXED_RIGHT, DoorTypeOperationEnum::INVERT_SWING_FIXED_LEFT,
  DoorTypeOperationEnum::TRIPLE_DOOR_SWING_RIGHT, DoorTypeOperationEnum::TRIPLE_DOOR_SWING_LEFT, DoorTypeOperationEnum::TRIPLE_DOOR_TRIPLE_SWING_RIGHT, DoorTypeOperationEnum::TRIPLE_DOOR_TRIPLE_SWING_LEFT
}
 
enum  Divider {
  Divider::NONE, Divider::VERTICAL, Divider::CROSS, Divider::HORIZONTAL,
  Divider::TWOVERTICAL
}
 
enum  PropertyKind {
  P_NO_MODIFICATION = 0, P_MODIFY_PLACEMENT = 1 << 0, P_LINK = 1 << 1, P_MODIFY_VISIBLITY = 1 << 3,
  P_MODIFY_SHAPE = 1 << 4, P_MODIFY_APPEARANCE = 1 << 5
}
 
enum  PName {
  m_No_Name = 0, m_GlobalId, m_OwnerHistory, m_Name,
  m_Description, m_ObjectType, m_ObjectPlacement, m_Representation,
  m_Radius, m_Position, m_Tag, m_XLength,
  m_YLength, m_ZLength, m_Location, m_Axis,
  m_RefDirection, m_Coordinates, m_Inverse = 10000, m_StyledByItem_inverse,
  m_HasAssignments_inverse, m_Nests_inverse, m_IsNestedBy_inverse, m_HasContext_inverse,
  m_IsDecomposedBy_inverse, m_Decomposes_inverse, m_HasAssociations_inverse, m_IsDeclaredBy_inverse,
  m_Declares_inverse, m_IsTypedBy_inverse, m_IsDefinedBy_inverse, m_ReferencedBy_inverse,
  m_FillsVoids_inverse, m_ConnectedTo_inverse, m_IsInterferedByElements_inverse, m_InterferesElements_inverse,
  m_HasProjections_inverse, m_ReferencedInStructures_inverse, m_HasOpenings_inverse, m_IsConnectionRealization_inverse,
  m_ProvidesBoundaries_inverse, m_ConnectedFrom_inverse, m_HasCoverings_inverse, m_ContainedInStructure_inverse,
  m_User = 20000
}
 
enum  SIPrefix {
  SIPrefix::EXA, SIPrefix::PETA, SIPrefix::TERA, SIPrefix::GIGA,
  SIPrefix::MEGA, SIPrefix::KILO, SIPrefix::HECTO, SIPrefix::DECA,
  SIPrefix::NONE, SIPrefix::DECI, SIPrefix::CENTI, SIPrefix::MILLI,
  SIPrefix::MICRO, SIPrefix::NANO, SIPrefix::PICO, SIPrefix::FEMTO,
  SIPrefix::ATTO
}
 
enum  SIUnitName {
  SIUnitName::AMPERE, SIUnitName::BECQUEREL, SIUnitName::CANDELA, SIUnitName::COULOMB,
  SIUnitName::CUBIC_METRE, SIUnitName::DEGREE_CELSIUS, SIUnitName::FARAD, SIUnitName::GRAM,
  SIUnitName::GRAY, SIUnitName::HENRY, SIUnitName::HERTZ, SIUnitName::JOULE,
  SIUnitName::KELVIN, SIUnitName::LUMEN, SIUnitName::LUX, SIUnitName::METRE,
  SIUnitName::MOLE, SIUnitName::NEWTON, SIUnitName::OHM, SIUnitName::PASCAL_UNIT,
  SIUnitName::RADIAN, SIUnitName::SECOND, SIUnitName::SIEMENS, SIUnitName::SIEVERT,
  SIUnitName::SQUARE_METRE, SIUnitName::STERADIAN, SIUnitName::TESLA, SIUnitName::VOLT,
  SIUnitName::WATT, SIUnitName::WEBER
}
 
enum  Quantity {
  Quantity::AMOUNT_OF_SUBSTANCE, Quantity::ELECTRIC_CURRENT, Quantity::LENGTH, Quantity::LUMINOUS_INTENSITY,
  Quantity::MASS, Quantity::TIME, Quantity::THERMODYNAMIC_TEMPERATURE, Quantity::ABSORBED_DOSE,
  Quantity::CATALYTIC_ACTIVITY, Quantity::ELECTRIC_CAPACITANCE, Quantity::ELECTRIC_CHARGE, Quantity::ELECTRIC_RESISTANCE,
  Quantity::ELECTRICAL_CONDUCTANCE, Quantity::ELECTRICAL_POTENTIAL_DIFFERENCE, Quantity::ELECTROMOTIVE_FORCE, Quantity::ENERGY,
  Quantity::EQUIVALENT_DOSE, Quantity::FORCE, Quantity::FREQUENCY, Quantity::HEAT,
  Quantity::ILLUMINANCE, Quantity::IMPEDANCE, Quantity::INDUCTANCE, Quantity::LUMINOUS_FLUX,
  Quantity::MAGNETIC_FIELD, Quantity::MAGNETIC_FLUX, Quantity::PLANE_ANGLE, Quantity::POWER,
  Quantity::PRESSURE, Quantity::RADIANT_FLUX, Quantity::RADIOACTIVITY, Quantity::REACTANCE,
  Quantity::SOLID_ANGLE, Quantity::STRESS, Quantity::TEMPERATURE, Quantity::VOLTAGE,
  Quantity::WEIGHT, Quantity::WORK, Quantity::AREA, Quantity::MASS_DENSITY,
  Quantity::AREA_DENSITY, Quantity::VOLUME
}
 

Functions

template<typename T >
T * cast2 (Base::BaseClass *b)
 
template<typename T >
const T * ccast2 (const Base::BaseClass *b)
 
template<typename BaseClassType , typename ClassType >
BaseClassType * CreateObject ()
 
void swap (double &a, double &b)
 
BASE_EXPORT Base::MessageBaseMessage (void)
 
BASE_EXPORT ProgressProgressSingleton ()
 
BASE_EXPORT void SequencerCallBackFunc_Default (int)
 
BASE_EXPORT Base::SequencerBaseSequencer (void)
 Singleton getter of the Sequencer. More...
 
BASE_EXPORT TestRunnerSingletonTestRunner (void)
 
BASE_EXPORT std::string getPrefixSymbol (Base::SIPrefix prefix)
 

Detailed Description

File name unification This class handles everything related to file names

The PropertyKind enum determines what a modification of this property does to the object it is contained in. The setting of the PropertyKind has direct influence on the recompute of an object: P_NO_MODIFICATION -> triggers NO RECOMPUTE P_MODIFY_PLACEMENT -> triggers a recompute of the objects placement only P_LINK -> depricated, don't use P_MODIFY_VISIBLITY -> triggers a change of the objects visibility P_MODIFY_SHAPE -> triggers a recompute of the objects shape. This always results in a recompute of the appearance aswell. P_MODIFY_APPEARANCE -> triggers a recompute of the objects appearance (color, textures, styles)

Typedef Documentation

◆ ProgressHandler

typedef std::function<void(ProgressInfo)> Base::ProgressHandler

◆ SequencerCallBackFunc

typedef std::function<void(int)> Base::SequencerCallBackFunc

Enumeration Type Documentation

◆ Divider

enum Base::Divider
strong
Enumerator
NONE 
VERTICAL 
CROSS 
HORIZONTAL 
TWOVERTICAL 

◆ DoorTypeOperationEnum

Enumerator
SINGLE_SWING_LEFT 
SINGLE_SWING_RIGHT 
DOUBLE_DOOR_SINGLE_SWING 
DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_LEFT 
DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_RIGHT 
DOUBLE_SWING_LEFT 
DOUBLE_SWING_RIGHT 
DOUBLE_DOOR_DOUBLE_SWING 
SLIDING_TO_LEFT 
SLIDING_TO_RIGHT 
DOUBLE_DOOR_SLIDING 
FOLDING_TO_LEFT 
FOLDING_TO_RIGHT 
DOUBLE_DOOR_FOLDING 
REVOLVING 
ROLLINGUP 
SWING_FIXED_LEFT 
SWING_FIXED_RIGHT 
USERDEFINED 
NOTDEFINED 
INVERT_SINGLE_SWING_RIGHT 
INVERT_SINGLE_SWING_LEFT 
INVERT_SWING_FIXED_RIGHT 
INVERT_SWING_FIXED_LEFT 
TRIPLE_DOOR_SWING_RIGHT 
TRIPLE_DOOR_SWING_LEFT 
TRIPLE_DOOR_TRIPLE_SWING_RIGHT 
TRIPLE_DOOR_TRIPLE_SWING_LEFT 

◆ FillingType

enum Base::FillingType
strong
Enumerator
NOFILLING 
WINDOW 
DOOR 

◆ OpeningType

enum Base::OpeningType
strong
Enumerator
WALL 
RECTANGLE 
TRAPEZOID 
ARCHED 
OCTAGON 
TRIANGLE 
CIRCLE_WIN 
ELLIPSE_WIN 
SEMICIRCLE 
FRENCHWINDOW 
DOOR 
GARAGEDOOR 
FLOOR 
ROOF 
GENERAL 
TYPE_FOR_COPY 
ARCHDOOR 
ARCHTOP 
PENTAGON 
QUARTERCIRCLE 
TRANSOMDOOR 

◆ PName

Enumerator
m_No_Name 
m_GlobalId 
m_OwnerHistory 
m_Name 
m_Description 
m_ObjectType 
m_ObjectPlacement 
m_Representation 
m_Radius 
m_Position 
m_Tag 
m_XLength 
m_YLength 
m_ZLength 
m_Location 
m_Axis 
m_RefDirection 
m_Coordinates 
m_Inverse 
m_StyledByItem_inverse 
m_HasAssignments_inverse 
m_Nests_inverse 
m_IsNestedBy_inverse 
m_HasContext_inverse 
m_IsDecomposedBy_inverse 
m_Decomposes_inverse 
m_HasAssociations_inverse 
m_IsDeclaredBy_inverse 
m_Declares_inverse 
m_IsTypedBy_inverse 
m_IsDefinedBy_inverse 
m_ReferencedBy_inverse 
m_FillsVoids_inverse 
m_ConnectedTo_inverse 
m_IsInterferedByElements_inverse 
m_InterferesElements_inverse 
m_HasProjections_inverse 
m_ReferencedInStructures_inverse 
m_HasOpenings_inverse 
m_IsConnectionRealization_inverse 
m_ProvidesBoundaries_inverse 
m_ConnectedFrom_inverse 
m_HasCoverings_inverse 
m_ContainedInStructure_inverse 
m_User 

◆ PropertyKind

Enumerator
P_NO_MODIFICATION 
P_MODIFY_PLACEMENT 
P_LINK 
P_MODIFY_VISIBLITY 
P_MODIFY_SHAPE 
P_MODIFY_APPEARANCE 

◆ PurposeGroup

enum Base::PurposeGroup
strong
Enumerator
DOOR 
GARAGE 
FRENCHWINDOW 
ARCHDOOR 
TRANSOMDOOR 

◆ Quantity

enum Base::Quantity
strong
Enumerator
AMOUNT_OF_SUBSTANCE 
ELECTRIC_CURRENT 
LENGTH 
LUMINOUS_INTENSITY 
MASS 
TIME 
THERMODYNAMIC_TEMPERATURE 
ABSORBED_DOSE 
CATALYTIC_ACTIVITY 
ELECTRIC_CAPACITANCE 
ELECTRIC_CHARGE 
ELECTRIC_RESISTANCE 
ELECTRICAL_CONDUCTANCE 
ELECTRICAL_POTENTIAL_DIFFERENCE 
ELECTROMOTIVE_FORCE 
ENERGY 
EQUIVALENT_DOSE 
FORCE 
FREQUENCY 
HEAT 
ILLUMINANCE 
IMPEDANCE 
INDUCTANCE 
LUMINOUS_FLUX 
MAGNETIC_FIELD 
MAGNETIC_FLUX 
PLANE_ANGLE 
POWER 
PRESSURE 
RADIANT_FLUX 
RADIOACTIVITY 
REACTANCE 
SOLID_ANGLE 
STRESS 
TEMPERATURE 
VOLTAGE 
WEIGHT 
WORK 
AREA 
MASS_DENSITY 
AREA_DENSITY 
VOLUME 

◆ SIPrefix

enum Base::SIPrefix
strong
Enumerator
EXA 
PETA 
TERA 
GIGA 
MEGA 
KILO 
HECTO 
DECA 
NONE 
DECI 
CENTI 
MILLI 
MICRO 
NANO 
PICO 
FEMTO 
ATTO 

◆ SIUnitName

enum Base::SIUnitName
strong
Enumerator
AMPERE 
BECQUEREL 
CANDELA 
COULOMB 
CUBIC_METRE 
DEGREE_CELSIUS 
FARAD 
GRAM 
GRAY 
HENRY 
HERTZ 
JOULE 
KELVIN 
LUMEN 
LUX 
METRE 
MOLE 
NEWTON 
OHM 
PASCAL_UNIT 
RADIAN 
SECOND 
SIEMENS 
SIEVERT 
SQUARE_METRE 
STERADIAN 
TESLA 
VOLT 
WATT 
WEBER 

Function Documentation

◆ cast2()

template<typename T >
T* Base::cast2 ( Base::BaseClass b)

◆ ccast2()

template<typename T >
const T* Base::ccast2 ( const Base::BaseClass b)

◆ CreateObject()

template<typename BaseClassType , typename ClassType >
BaseClassType* Base::CreateObject ( )

◆ getPrefixSymbol()

BASE_EXPORT std::string Base::getPrefixSymbol ( Base::SIPrefix  prefix)

◆ Message()

BASE_EXPORT Base::MessageBase& Base::Message ( void  )
inline

◆ ProgressSingleton()

BASE_EXPORT Progress& Base::ProgressSingleton ( )

◆ Sequencer()

BASE_EXPORT Base::SequencerBase& Base::Sequencer ( void  )
inline

Singleton getter of the Sequencer.

◆ SequencerCallBackFunc_Default()

BASE_EXPORT void Base::SequencerCallBackFunc_Default ( int  )

◆ swap()

void Base::swap ( double &  a,
double &  b 
)
inline

◆ TestRunner()

BASE_EXPORT TestRunnerSingleton& Base::TestRunner ( void  )
inline