class
ScriptSymbolConfigObject.
ScriptSymbolConfigObjectMarker
Bases: object
Every ScriptObject instance will be extended with this method.
Version added
3.5.10.0
is_symbol_config
Gets a value indicating whether this instance is a symbol config object.
Return type
bool
Returns
True if this instance is symbol config object, otherwise False.
class
ScriptSymbolConfigObject.
ScriptSymbolConfigObject
Bases: ScriptSymbolConfigObject.ScriptSymbolConfigObjectMarker
Functionality for manipulating symbol configuration objects.
Version added
3.5.10.0
client_side_layout_calculator_guid
Gets or sets the Guid denoting the currently configured client side layout calculator.
Currently, two different values are allowed: Guid.Empty to use the Compatibility Offset Calculator which is always available. And "{0141eb75-141b-4ea1-9a8c-75f952b22a6c}" to use the OptimizedOutputOffsetCalculator which is new with V3.5.7.0 and also requires the compiler version 3.5.7.0 (see http://jira.3s-software.com/browse/CDS-41816). This scheme may be extended to allow more or even arbitrary offset calculators in the future.
Return type
Guid
client_side_layout_calculator
Gets or sets the calculator object denoting the currently configured client side layout calculator.
Currently, two different values are allowed: Guid.Empty to use the Compatibility Offset Calculator which is always available. And "{0141eb75-141b-4ea1-9a8c-75f952b22a6c}" to use the OptimizedOutputOffsetCalculator which is new with V3.5.7.0 and also requires the compiler version 3.5.7.0 (see http://jira.3s-software.com/browse/CDS-41816). This scheme may be extended to allow more or even arbitrary offset calculators in the future.
Return type
available_client_side_layout_calculators
Gets all currently known layout calculators.
enable_direct_io_access
Gets or sets a boolean whether direct Access to the I/O Area is configured.
Enabling direct access to the I/O area is supported for debugging purposes, e. G. testing the cables and connections. It is not meant for productive operation. It is only available under certain conditions, e. G. the compiler version must be >= V3.5.8.0 and the symbol config must not be generated as a child application.
Return type
bool
check_effective_direct_io_access
Checks whether and why the direct Access to the I/O Area is effectively enabled / disabled.
Enabling direct access to the I/O area is supported for debugging purposes, e. G. testing the cables and connections. It is not meant for productive operation. It is only available under certain conditions, e. G. the compiler version must be >= V3.5.8.0 and the symbol config must not be generated as a child application.
Return type
DirectIoAccessObstacles
Returns
The DirectIoAccessObstacles flag describing which reasons prevent the Direct IO Access from being enabled.
get_direct_io_obstacle_explanations
obstacles
Gets user readable, localized messages / explanations of the obstacles.
Parameters
obstacles (DirectIoAccessObstacles) -- The obstacles.
Return type
list <str>
Returns
A list of strings with one entry for each obstacle, or an "is enabled" message when obstacles == DirectIoAccessObstacles.None.
content_feature_flags
The configured content feature flags. This is partially redundant with SymbolConfigObject.ExportCommentsInXML and SymbolConfigObject.SupportOPCUA.
Return type
SymbolConfigContentFeatureFlags
effective_content_feature_flags
The effective content feature flags, considering the content_feature_flags and the compiler version setting.
Return type
SymbolConfigContentFeatureFlags
get_symbol_configuration_xsd
Gets the current symbol configuration XML schema, as appropriate for the current symbol config object.
The schema is delivered as a byte array, containing the UTF-8 encoded XSD file as it is also published in the http://www.3s-software.com/schemas/Symbolconfiguration.xsd. The above URL aways points to the newest released version of the schema, while the get_symbol_configuration_xsd() property delivers the XSD file applicable to the current release of the SymbolConfig plugin.
Return type
list <byte>
Returns
The current symbol configuration XML schema as byte array.
symbol_attribute_filter_type
The configured filter type for the attributes.
Return type
SymbolAttributeFilterTypes
effective_symbol_attribute_filter_type
The effective filter type, considering compiler version and other side conditions.
Return type
SymbolAttributeFilterTypes
symbol_attribute_filter_data
Describes the filter data for SymbolAttributeFilterTypes.Prefix and SymbolAttributeFilterTypes.Regex.
Return type
str
symbol_comment_filter_type
The configured comment filter type.
Return type
SymbolCommentFilterType
effective_symbol_comment_filter_type
The effective comment filter type, considering compiler version and other side conditions.
Return type
SymbolCommentFilterType
get_all_signatures
compile=True
Get all signatures (compiler and configured).
Parameters
compile (bool) -- If True, build the application before generating the list. If the application was not built before, the returned list is empty.
Return type
Returns
Collection of signatures.
get_all_datatypes
compile=True
Get all data types (compiler and configured).
Parameters
compile (bool) -- If True, build the application before generating the list. If the application was not built before, the returned list is empty.
Return type
Returns
Collection of data types.
get_only_configured_signatures
Get only the configured signatures.
Return type
Returns
Collection of signatures.
get_only_configured_datatypes
Get only the configured data types.
Return type
Returns
Collection of data types.
class
ScriptSymbolConfigObject.
ScriptClientSideLayoutCalculatorDescriptionCollection
Bases: list
Descriptions of the client side layout calculators.
Version added
3.5.10.0
class
ScriptSymbolConfigObject.
ScriptClientSideLayoutCalculatorDescription
Bases: object
Description of an client side layout calculator.
Currently, two different values are allowed: Guid.Empty to use the Compatibility Offset Calculator which is always available. And "{0141eb75-141b-4ea1-9a8c-75f952b22a6c}" to use the OptimizedOutputOffsetCalculator which is new with V3.5.7.0 and also requires the compiler version 3.5.7.0 (see http://jira.3s-software.com/browse/CDS-41816). This scheme may be extended to allow more or even arbitrary offset calculators in the future.
Version added
3.5.10.0
type_guid
The unique ID of the output layout calculator.
Return type
Guid
name
The name of the output layout calculator - human readable and localized.
Return type
str
description
A longer description of the output layout calculator.
Return type
This may be shown in a tooltip, and should give some detailed explanation of the calculator, and e. G. the conditions under which the calculator is valid.
class
ScriptSymbolConfigObject.
ScriptSymbolConfigSignature
Bases: object
Signature element of the symbol configuration.
Version added
3.5.10.0
name
The name of this element.
Return type
str
full_qualified_name
The full qualified name of this element.
Return type
str
library_id
The identification of the library where this signature is declared.
Return type
str
namespace_path
Namespace path of the library where this signature is declared.
Return type
list <str>
variables
The variables of the signature.
Return type
ScriptSymbolConfigVariableCollection
class
ScriptSymbolConfigObject.
ScriptSymbolConfigSignatureCollection
Bases: list
Collection of symbol configuration signatures.
Version added
3.5.10.0
find
name
library_id=None
Get the first ScriptSymbolConfigSignature with the specified name and library ID which should be fully qualified.
Parameters
name (str) -- Name of a signature.
library_id (str) -- Library ID.
Return type
Returns
Signature of the symbol configuration. Otherwise None.
class
ScriptSymbolConfigObject.
ScriptSymbolConfigVariable
Bases: object
Variable element of the symbol configuration.
Version added
3.5.10.0
name
The name of this variable.
Return type
str
type
The type of this variable, as the user declared it.
Return type
str
comment
Gets the comment of the signature or variable, or an empty string if no comment is available.
This member is only valid for objects parsed from the compiler, not for configured symbol config instances.
Return type
str
configured_access
The allowed symbolic access to this variable.
Return type
SymbolAccess
maximal_access
The maximal access that is allowed for this variable, decided by the given attributes.
Return type
SymbolAccess
effective_access
The effective symbolic access to this variable.
Return type
SymbolAccess
exported_via_attribute
Gets a value indicating whether this variable is configured via compiler attribute.
Return type
bool
Returns
True if exported via attribute; otherwise False. If True, the Access attribute gives the effective access for this variable.
attribute_access
Gets the attribute access. When attribute_access is false, the result of this member is undefined.
Return type
SymbolAccess
type_library_id
Gets the library id, when the type of the member is from a library.
This is currently only set for supported data types (userdef and array).
Return type
str
full_qualified_base_type
Gets the full qualified base type of the member.
This is currently only set for supported data types (userdef and array).
Return type
str
alias_type
The name of the alias type.
For variables with aliased types, the Type, SymbolConfigVariable.VariableType and SymbolConfigVariable2.FullQualifiedBaseType properties point to the effective, resolved type. Use this member in the UI to display the alias type used in the source. This member is only valid for objects parsed from the compiler, not for configured symbol config instances.
Return type
str
class
ScriptSymbolConfigObject.
ScriptApplicationSymbolConfigExtension
Bases: object
Extension provider for ApplicationObject instances.
Version added
3.5.10.0
create_symbol_config
export_comments_to_xml
support_opc_ua
client_side_layout_calculator
Add the symbol configuration object to an application.
Return type
Returns
Script object of the symbol config object.
exception
ScriptSymbolConfigObject.
ScriptSymbolConfigInvalidObjectException
stMessage
Bases: Exception
Exception which is thrown when the symbol configuration object is modified externally and so the scripting objects are not valid anymore.
Version added
3.5.10.0
