NemAll_Python_AllplanSettings

Exposed classes and functions from NemAll_Python_AllplanSettings

 
Classes
       
Boost.Python.enum(builtins.int)
LengthUnits
Boost.Python.instance(builtins.object)
AllplanGlobalSettings
AllplanLocalisationService
AllplanPaths
AllplanVersion
FontProvider
ImperialUnitService

 
class AllplanGlobalSettings(Boost.Python.instance)
    Class for getting global Allplan settings
 
 
Method resolution order:
AllplanGlobalSettings
Boost.Python.instance
builtins.object

Methods defined here:
GetCurrentColorId(...)
GetCurrentColorId() -> int :
    Get the current used ColorId in Allplan
    
    Return:  Current ColorId
GetCurrentFaceStyleId(...)
GetCurrentFaceStyleId() -> int :
    Get the current used FaceStyleId in Allplan
    
    Return:  Current FaceStyleId
GetCurrentFontId(...)
GetCurrentFontId() -> int :
    Get the current used FontId in Allplan
    
    Return:  Current FontId
GetCurrentHatchId(...)
GetCurrentHatchId() -> int :
    Get the current used HatchId in Allplan
    
    Return:  Current HatchId
GetCurrentLayerId(...)
GetCurrentLayerId() -> int :
    Get the current used LayerId in Allplan
    
    Return:  Current LayerId
GetCurrentPatternId(...)
GetCurrentPatternId() -> int :
    Get the current used PatternId in Allplan
    
    Return:  Current PatternId
GetCurrentPenId(...)
GetCurrentPenId() -> int :
    Get the current used PenId in Allplan
    
    Return:  Current PenId
GetCurrentStrokeId(...)
GetCurrentStrokeId() -> int :
    Get the current used StrokeId in Allplan
    
    Return:  Current StrokeId
GetOffsetPoint(...)
GetOffsetPoint() -> Point3D :
    Get the offset point
    
    Return:  OffsetPoint
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class AllplanLocalisationService(Boost.Python.instance)
    Class for extraction of Allplan localization settings
 
 
Method resolution order:
AllplanLocalisationService
Boost.Python.instance
builtins.object

Methods defined here:
AllplanLanguage(...)
AllplanLanguage() -> str :
    Get the installed Allplan language
    
    Return:  Allplans currently used language as a three letter description
    
           bul - Bulgarian
           deu - German
           eng - English
           fin - Finnish
           fra - French
           grc - Greek
           hol - Dutch
           hrv - Croatian
           ita - Italian
           pol - Polish
           rum - Romanian
           rus - Russian
           slk - Slovak
           spa - Spanish
           svn - Slovenian
           tch - Czech
           trk - Turkish
           ung - Hungarian
           dan - Danish
           ser - Serbian
           mak - Macedonian
           prt - Portuguese
           ltu - Lithuanian
           lva - Latvian
           est - Estonian
           ukr - Ukrainian
           swe - Swedish
           nor - Norwegian
           chn - Chinese
           kor - Korean
           jpn - Japanese
           usa - USA - English
Language(...)
Language() -> str :
    Get the current Allplan language
    
    Return:  Allplans currently used language as a two letter description
    
           bg - Bulgarian
           de - German
           en - English
           fi - Finnish
           fr - French
           el - Greek
           nl - Dutch
           hr - Croatian
           it - Italian
           pl - Polish
           ro - Romanian
           ru - Russian
           sk - Slovak
           es - Spanish
           sl - Slovenian
           cs - Czech
           tr - Turkish
           hu - Hungarian
           da - Danish
           sr - Serbian
           mk - Macedonian
           pt - Portuguese
           lt - Lithuanian
           lv - Latvian
           et - Estonian
           uk - Ukrainian
           sv - Swedish
           no - Norwegian
           zh - Chinese
           ko - Korean
           ja - Japanese
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class AllplanPaths(Boost.Python.instance)
    Class for getting Allplan paths
 
 
Method resolution order:
AllplanPaths
Boost.Python.instance
builtins.object

Methods defined here:
GetCurPrjDesignPath(...)
GetCurPrjDesignPath() -> str :
    Get the current project design path
    
    Return:  Current project design path
GetCurPrjPath(...)
GetCurPrjPath() -> str :
    Get the current project path
    
    Return:  Current project path
GetEtcPath(...)
GetEtcPath() -> str :
    Get the Etc path
    
    Return:  Etc path
GetPrgPath(...)
GetPrgPath() -> str :
    Get the program path
    
    Return:  Program path
GetStdDesignPath(...)
GetStdDesignPath() -> str :
    Get the Std design path
    
    Return:  Std design path
GetStdPath(...)
GetStdPath() -> str :
    Get the Std path
    
    Return:  Std path
GetTmpPath(...)
GetTmpPath() -> str :
    Get the Tmp path
    
    Return:  Tmp path
GetUsrPath(...)
GetUsrPath() -> str :
    Get the Usr path
    
    Return:  Usr path
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class AllplanVersion(Boost.Python.instance)
    Class for extraction of Allplan version information
 
 
Method resolution order:
AllplanVersion
Boost.Python.instance
builtins.object

Methods defined here:
MainReleaseName(...)
MainReleaseName() -> str :
    Get the Allplan main release name
    Return:  Allplan main release name ('2016', '2017', ...)
SubReleaseName(...)
SubReleaseName() -> str :
    Get the Allplan sub release name
    Return:  Allplan sub release name ('2016.0', '2016.1', ...)
Version(...)
Version() -> str :
    Get the Allplan version as string
    Return:  Allplan version
     2016.1
         2016: Allplan main version
         .1:   Allplan sub version
    
     2016.1.1
         2016: Allplan main version
         .1.1: Allplan sub version
WindowsReleaseName(...)
WindowsReleaseName() -> str :
    Get the Allplan window release name
    Return: 'P' for project version or empty string for the normal version
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class FontProvider(Boost.Python.instance)
    Font provider
 
 
Method resolution order:
FontProvider
Boost.Python.instance
builtins.object

Methods defined here:
GetFontID(...)
GetFontID( (FontProvider)arg1, (str)arg2, (bool)fontName) -> int :
    Return ID for the given font
    
    In case, that this font is not installed, the function returns 0.
    
    When bCheckExistence is FALSE then the function returns the ID of the font regardless of it is installed or not.
    
    Return the ID for the given font name. ID is the index to the table m_PreDefinedFontNameList.
    
     etval 0                                Dialog Font ID
     etval 1-20                             ID of the hardcoded Allplan's fonts
     etval 21-63                            ID of the hardcoded system's fonts)
     etval >=SYSTEM_FONT_ID (1000)          ID of the system TTF font ( this ID is valid only during Allplan's session )
     etval >=NON_EXISTING_FONT_ID(10000)    ID of the font that isn't installed nor exists in the predefined table( this ID is valid only during Allplan's session )
     etval INVALID_FONT_ID(N_FONT_INTERNAL_MIN_ID - 1) Invalid ID, font with given name doesn't exist
    
    Parameter: fontName         Name of the font
               bCheckExistence  When bCheckExistence is TRUE then the font with the particular ID has to be installed.
    
                                In case, that this font is not installed, the function returns the empty string.
    
                                When bCheckExistence is FALSE then the function returns the name of the font regardless of it is installed or not.
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods defined here:
Instance(...)
Instance() -> FontProvider

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class ImperialUnitService(Boost.Python.instance)
    Imperial unit service
 
 
Method resolution order:
ImperialUnitService
Boost.Python.instance
builtins.object

Methods defined here:
ConvertToMM(...)
ConvertToMM( (str)arg1) -> tuple
IsImperialUnit(...)
IsImperialUnit() -> bool
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class LengthUnits(Boost.Python.enum)
    Length units
 
 
Method resolution order:
LengthUnits
Boost.Python.enum
builtins.int
builtins.object

Data and other attributes defined here:
eCentimeters = NemAll_Python_AllplanSettings.LengthUnits.eCentimeters
eDecimeters = NemAll_Python_AllplanSettings.LengthUnits.eDecimeters
eFeets = NemAll_Python_AllplanSettings.LengthUnits.eFeets
eFeetsAndInchesDecimal = NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesDecimal
eFeetsAndInchesExact = NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesExact
eFeetsAndInchesFractional = NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesFractional
eInchesDecimal = NemAll_Python_AllplanSettings.LengthUnits.eInchesDecimal
eInchesExact = NemAll_Python_AllplanSettings.LengthUnits.eInchesExact
eInchesFractional = NemAll_Python_AllplanSettings.LengthUnits.eInchesFractional
eKilometers = NemAll_Python_AllplanSettings.LengthUnits.eKilometers
eMeters = NemAll_Python_AllplanSettings.LengthUnits.eMeters
eMillimeters = NemAll_Python_AllplanSettings.LengthUnits.eMillimeters
names = {'eCentimeters': NemAll_Python_AllplanSettings.LengthUnits.eCentimeters, 'eDecimeters': NemAll_Python_AllplanSettings.LengthUnits.eDecimeters, 'eFeets': NemAll_Python_AllplanSettings.LengthUnits.eFeets, 'eFeetsAndInchesDecimal': NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesDecimal, 'eFeetsAndInchesExact': NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesExact, 'eFeetsAndInchesFractional': NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesFractional, 'eInchesDecimal': NemAll_Python_AllplanSettings.LengthUnits.eInchesDecimal, 'eInchesExact': NemAll_Python_AllplanSettings.LengthUnits.eInchesExact, 'eInchesFractional': NemAll_Python_AllplanSettings.LengthUnits.eInchesFractional, 'eKilometers': NemAll_Python_AllplanSettings.LengthUnits.eKilometers, ...}
values = {0: NemAll_Python_AllplanSettings.LengthUnits.eMillimeters, 1: NemAll_Python_AllplanSettings.LengthUnits.eCentimeters, 2: NemAll_Python_AllplanSettings.LengthUnits.eDecimeters, 3: NemAll_Python_AllplanSettings.LengthUnits.eMeters, 4: NemAll_Python_AllplanSettings.LengthUnits.eKilometers, 5: NemAll_Python_AllplanSettings.LengthUnits.eInchesDecimal, 6: NemAll_Python_AllplanSettings.LengthUnits.eInchesFractional, 7: NemAll_Python_AllplanSettings.LengthUnits.eInchesExact, 8: NemAll_Python_AllplanSettings.LengthUnits.eFeets, 9: NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesDecimal, ...}

Methods inherited from Boost.Python.enum:
__repr__(self, /)
Return repr(self).
__str__(self, /)
Return str(self).

Data descriptors inherited from Boost.Python.enum:
name

Methods inherited from builtins.int:
__abs__(self, /)
abs(self)
__add__(self, value, /)
Return self+value.
__and__(self, value, /)
Return self&value.
__bool__(self, /)
self != 0
__ceil__(...)
Ceiling of an Integral returns itself.
__divmod__(self, value, /)
Return divmod(self, value).
__eq__(self, value, /)
Return self==value.
__float__(self, /)
float(self)
__floor__(...)
Flooring an Integral returns itself.
__floordiv__(self, value, /)
Return self//value.
__format__(...)
default object formatter
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getnewargs__(...)
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__index__(self, /)
Return self converted to an integer, if self is suitable for use as an index into a list.
__int__(self, /)
int(self)
__invert__(self, /)
~self
__le__(self, value, /)
Return self<=value.
__lshift__(self, value, /)
Return self<<value.
__lt__(self, value, /)
Return self<value.
__mod__(self, value, /)
Return self%value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__neg__(self, /)
-self
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__or__(self, value, /)
Return self|value.
__pos__(self, /)
+self
__pow__(self, value, mod=None, /)
Return pow(self, value, mod).
__radd__(self, value, /)
Return value+self.
__rand__(self, value, /)
Return value&self.
__rdivmod__(self, value, /)
Return divmod(value, self).
__rfloordiv__(self, value, /)
Return value//self.
__rlshift__(self, value, /)
Return value<<self.
__rmod__(self, value, /)
Return value%self.
__rmul__(self, value, /)
Return value*self.
__ror__(self, value, /)
Return value|self.
__round__(...)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
__rpow__(self, value, mod=None, /)
Return pow(value, self, mod).
__rrshift__(self, value, /)
Return value>>self.
__rshift__(self, value, /)
Return self>>value.
__rsub__(self, value, /)
Return value-self.
__rtruediv__(self, value, /)
Return value/self.
__rxor__(self, value, /)
Return value^self.
__sizeof__(...)
Returns size in memory, in bytes
__sub__(self, value, /)
Return self-value.
__truediv__(self, value, /)
Return self/value.
__trunc__(...)
Truncating an Integral returns itself.
__xor__(self, value, /)
Return self^value.
bit_length(...)
int.bit_length() -> int
 
Number of bits necessary to represent self in binary.
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate(...)
Returns self, the complex conjugate of any int.
from_bytes(...) from builtins.type
int.from_bytes(bytes, byteorder, *, signed=False) -> int
 
Return the integer represented by the given array of bytes.
 
The bytes argument must be a bytes-like object (e.g. bytes or bytearray).
 
The byteorder argument determines the byte order used to represent the
integer.  If byteorder is 'big', the most significant byte is at the
beginning of the byte array.  If byteorder is 'little', the most
significant byte is at the end of the byte array.  To request the native
byte order of the host system, use `sys.byteorder' as the byte order value.
 
The signed keyword-only argument indicates whether two's complement is
used to represent the integer.
to_bytes(...)
int.to_bytes(length, byteorder, *, signed=False) -> bytes
 
Return an array of bytes representing an integer.
 
The integer is represented using length bytes.  An OverflowError is
raised if the integer is not representable with the given number of
bytes.
 
The byteorder argument determines the byte order used to represent the
integer.  If byteorder is 'big', the most significant byte is at the
beginning of the byte array.  If byteorder is 'little', the most
significant byte is at the end of the byte array.  To request the native
byte order of the host system, use `sys.byteorder' as the byte order value.
 
The signed keyword-only argument determines whether two's complement is
used to represent the integer.  If signed is False and a negative integer
is given, an OverflowError is raised.

Data descriptors inherited from builtins.int:
denominator
the denominator of a rational number in lowest terms
imag
the imaginary part of a complex number
numerator
the numerator of a rational number in lowest terms
real
the real part of a complex number

 
Functions
       
GetLengthUnit(...)
GetLengthUnit() -> LengthUnits

 
Data
        eCentimeters = NemAll_Python_AllplanSettings.LengthUnits.eCentimeters
eDecimeters = NemAll_Python_AllplanSettings.LengthUnits.eDecimeters
eFeets = NemAll_Python_AllplanSettings.LengthUnits.eFeets
eFeetsAndInchesDecimal = NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesDecimal
eFeetsAndInchesExact = NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesExact
eFeetsAndInchesFractional = NemAll_Python_AllplanSettings.LengthUnits.eFeetsAndInchesFractional
eInchesDecimal = NemAll_Python_AllplanSettings.LengthUnits.eInchesDecimal
eInchesExact = NemAll_Python_AllplanSettings.LengthUnits.eInchesExact
eInchesFractional = NemAll_Python_AllplanSettings.LengthUnits.eInchesFractional
eKilometers = NemAll_Python_AllplanSettings.LengthUnits.eKilometers
eMeters = NemAll_Python_AllplanSettings.LengthUnits.eMeters
eMillimeters = NemAll_Python_AllplanSettings.LengthUnits.eMillimeters