![]() | AMLInternal |
The AMLInternalElementType type exposes the following members.
Name | Description | |
---|---|---|
![]() | AMLInternalElementType | Initializes a new instance of the AMLInternalElementType class. |
Name | Description | |
---|---|---|
![]() | AdditionalInformation |
Gets the collection of AdditionalInformation values contained in this instance.
(Inherited from CAEXBasicObject) |
![]() | AMLFacets |
Gets the Collection of AMLFacet objects.
(Inherited from AMLSystemUnitClass) |
![]() | AMLGroups |
Gets the Collection of AMLGroup objects.
(Inherited from AMLSystemUnitClass) |
![]() | AMLPorts |
Gets the Collection of AMLPort objects.
(Inherited from AMLSystemUnitClass) |
![]() | Attribute |
Gets the collection of Attribute objects for this instance.
(Inherited from SystemUnitClassType) |
![]() | AttributeAndDescendants |
Gets the attributes and all nested attributes.
(Inherited from SystemUnitClassType) |
![]() | CAEXDocument |
Gets the CAEX document of this CAEX object. If the CAEX object has not been inserted
into a document or has been removed from the document, the value is null.
(Inherited from CAEXWrapper) |
![]() | CAEXParent |
Gets the CAEXParent of this instance if it exists.
(Inherited from CAEXWrapper) |
![]() | CAEXSequenceOfCAEXObject |
Gets the CAEXSequence containing this CAEX object
(Inherited from CAEXWrapper) |
![]() | ChangeMode |
Gets and sets the change mode for a CAEX element (Optional in CAEX).
(Inherited from CAEXBasicObject) |
![]() | Copyright |
Gets and sets the Copyright for this object.
(Inherited from CAEXBasicObject) |
![]() | CopyrightElement |
Gets the wrapper for the Copyright element.
(Inherited from CAEXBasicObject) |
![]() | Description |
Gets and sets the Description for this object.
(Inherited from CAEXBasicObject) |
![]() | DescriptionElement |
Gets the wrapper for the Description element.
(Inherited from CAEXBasicObject) |
![]() | Document |
Gets the XDocument of the wrapped XML-Element
(Inherited from CAEXWrapper) |
![]() | Exists |
Determines if this is a wrapper around an existing XML-Element
(Inherited from CAEXWrapper) |
![]() | ExternalInterface |
Gets a collection of ExternalInterface objects contained in this instance.
(Inherited from SystemUnitClassType) |
![]() | ExternalInterfaceAndDescendants |
Gets the collection of ExternalInterface objects including all nested descendant interfaces
(Inherited from SystemUnitClassType) |
![]() | ID |
Gets and sets a unique identifier of the CAEX object (optional in CAEX). AutomationML requires IDs for some
Elements.
These IDs are automatically set when such elements are created.
(Inherited from CAEXObject) |
![]() | InternalElement |
Gets the collection of InternalElement objects for this instance.
(Inherited from SystemUnitClassType) |
![]() | InternalLink |
Gets the collection of InternalLink objects contained in this instance.
(Inherited from SystemUnitClassType) |
![]() | IsDeleted |
Determines, if this object is not contained in any document
(Inherited from CAEXWrapper) |
![]() | Name |
Gets and sets the name of the CAEX object (required in CAEX).
(Inherited from CAEXObject) |
![]() | Node |
Gets the wrapped XML-Element
(Inherited from CAEXWrapper) |
![]() | Owner |
Gets the wrapped Xml-Element's parent
(Inherited from CAEXWrapper) |
![]() | Reference |
Gets the referenced class
(Inherited from CaexObjectWithReferenceT) |
![]() | ReferenceAttributeName |
Gets the Name of the attribute of the wrapped Xml-Element, which is used to define the reference to the base class.
(Inherited from CaexObjectWithReferenceT) |
![]() | Revision |
Gets the collection of Revision objects contained in this instance.
(Inherited from CAEXBasicObject) |
![]() | RoleReferences |
Gets all role references for the SystemUnitClass. The collection includes all
RoleRequirement objects and SupportedRoleClass objects.
(Inherited from SystemUnitClassType) |
![]() | Roles |
Gets all role classes for the SystemUnitClass. The collection includes all
RoleClasses, referenced by RoleRequirement objects and SupportedRoleClass objects.
(Inherited from SystemUnitClassType) |
![]() | SourceObjectInformation |
Gets the collection of SourceObjectInformation objects contained in this instance.
(Inherited from CAEXBasicObject) |
![]() | SupportedRoleClass |
Gets the collection of SupportedRoleClass objects contained in this instance.
(Inherited from SystemUnitClassType) |
![]() | TagName |
Gets the name of the CAEX tag for this CAEX object.
(Inherited from CAEXWrapper) |
![]() | Version |
Gets and sets the Version for this object.
(Inherited from CAEXBasicObject) |
![]() | VersionElement |
Gets the wrapper for the Version element.
(Inherited from CAEXBasicObject) |
Name | Description | |
---|---|---|
![]() | AddChild |
Appends a new element of the same type as this instance as a child element
(Inherited from CaexObjectWithReferenceT) |
![]() | AddFacet |
Adds an AMLFacet object to the AMLSystemUnitClass with the provided name.
(Inherited from AMLSystemUnitClass) |
![]() | AddGroup |
Adds an AMLGroup object to the AMLSystemUnitClass with the provided name.
(Inherited from AMLSystemUnitClass) |
![]() ![]() | AddInterfaceClassReference(InterfaceFamilyType, Boolean, Boolean, String) |
Adds an InterfaceClass reference to this SystemUnitClass object using the provided
InterfaceClass object. The InterfaceClass reference is added as
a ExternalInterfaceType object.
(Inherited from SystemUnitClassType) |
![]() ![]() | AddInterfaceClassReference(String, Boolean, Boolean, String) |
Adds an InterfaceClass reference to this SystemUnitClass object using the provided
CAEX path, referencing an InterfaceClass object. The InterfaceClass reference is added as
a ExternalInterfaceType object.
(Inherited from SystemUnitClassType) |
![]() | AddPort |
Adds an AMLPort object to the AMLSystemUnitClass with the provided name.
(Inherited from AMLSystemUnitClass) |
![]() | AddReference |
Adds a reference to the provided referenced class using the CAEXPath of the
referenced class as the reference attribute value.
(Inherited from CaexObjectWithReferenceT) |
![]() | AssignNewGuidAsID |
Assigns the new unique identifier as a new ID to this CAEX object.
(Inherited from CAEXObject) |
![]() | CAEXChild |
Gets the first child of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper) |
![]() | CAEXChildren |
Gets all children of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper) |
![]() | CAEXPath |
Gets the CAEX path for this object. A path can be used to uniquely reference an object,
for example in inheritances and instances. The path syntax for an object is defined
differently in CAEX 2.15 and CAEX 3.0. The engine uses the CAEXPathBuilder to generate
the CAEX path of an object according to the documents CAEX version.
(Inherited from CAEXObject) |
![]() | CAEXSequence |
Gets the CAEXSequence owned by this CAEX object, which contains the specified CAEX object.
(Inherited from SystemUnitClassType) |
![]() | CanAddReference |
Determines if this CAEX object can reference the provided target CAEX object
using the reference attribute.
(Inherited from CaexObjectWithReferenceT) |
![]() | ContainerT |
Gets the CAEX Container for elements of type T, which is owned by this CAEX object
(Inherited from SystemUnitClassType) |
![]() | Copy |
Creates a copy of this CAEX object, containing all child elements.
The created copy will have replaced unique IDs and updated references, if
the assignNewIDs is set to true (default).
When a CAEX class is copied, the nested classes that can exist for AttributeType,
RoleClass, SystemUnitClass, and InterfaceClass could be included in the created copy, if
the includeSubClasses is set to true.
(Inherited from CAEXObject) |
![]() | Equals |
Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper) |
![]() | GetEnumerator |
Enumeration of contained InternalElement objects
(Inherited from SystemUnitClassType) |
![]() | GetHashCode |
Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper) |
![]() | GetXAttributeValue |
Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element.
(Inherited from CAEXWrapper) |
![]() ![]() | HasInterfaceClassReference |
Determines whether this CAEX Element has an associated reference to
the specified InterfaceClass. If inheritance relations between InterfaceClasses should be regarded, the
optional parameter 'regardInheritance' should be set. In this case the specified InterfaceClass is either identical
to a referenced InterfaceClass or a referenced InterfaceClass is derived from the specified InterfaceClass.
(Inherited from SystemUnitClassType) |
![]() | Import |
Imports the specified CAEX object in it's associated sequence. The provided
CAEX object is copied and all references are recalculated before it is
inserted.
(Inherited from SystemUnitClassType) |
![]() | Insert(CAEXWrapper, Boolean) |
Inserts the specified CAEX object in it's associated sequence. The SystemUnitClass
defines the Attribute, ExternalInterface,
InternalElement, InternalLink, and
SupportedRoleClass sequence.
(Inherited from SystemUnitClassType) |
![]() | Insert(Int32, CAEXWrapper) |
Inserts the specified CAEX object in it's associated sequence. The SystemUnitClass
defines the Attribute, ExternalInterface,
InternalElement, InternalLink, and
SupportedRoleClass sequence.
(Inherited from SystemUnitClassType) |
![]() | InsertAfter(T) |
Inserts the provided CAEX object as a new sibling after this CAEX object.
(Inherited from CaexObjectWithReferenceT) |
![]() | InsertAfter(InternalElementType) |
Inserts the provided CAEX object as a new sibling after this CAEX object.
(Inherited from SystemUnitClassType) |
![]() | InsertBefore(T) |
Inserts the provided CAEX object as a new sibling before this CAEX object.
(Inherited from CaexObjectWithReferenceT) |
![]() | InsertBefore(InternalElementType) |
Inserts the provided CAEX object as a new sibling before this CAEX object.
(Inherited from SystemUnitClassType) |
![]() | InsertNew |
This method can be used to create an XML node, if this CAEX wrapper was instantiated without an XML node.
This method can only be applied, if an Owner is defined. The new created CAEX object is
inserted as a new child of the owner.
(Inherited from CAEXWrapper) |
![]() | LowestCommonParent |
Gets the Lowest common parent to this SystemUnitClass and the provided SystemUnitClass. The common parent is used
to
store an InternalLink relating this two SystemUnitClass objects. An InternalLink is not allowed to leave the
boundary of
a SystemUnitClass which means, that no common parent is defined for two different SystemUnitClass objects. If one
Element
is a SystemUnitClass the other one should be an InternalElement descendant of the SystemUnitClass.
(Inherited from SystemUnitClassType) |
![]() | New_Revision |
Creates a new Revision object and inserts it to the collection of Revision objects Revision
either at the beginning or at the end of the sequence, according to the specified optional value. The Revision
object is initialized with the provided values.
(Inherited from CAEXBasicObject) |
![]() | Remove |
Removes this element. After that it is no longer assigned to a document and has no owner anymore.
(Inherited from CAEXWrapper) |
![]() | SetXAttributeValue |
Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null).
(Inherited from CAEXWrapper) |
![]() | SupportedRoleClassWithName |
Get the RoleClass from the sequence of SupportedRoleClass with the provided
roleClassName.
(Inherited from SystemUnitClassType) |
![]() | ToString |
Returns the value of the 'Name' attribute of this CAEX object as the string representation of the object.
(Inherited from CAEXObject) |
Name | Description | |
---|---|---|
![]() | PropertyChanged |
The Change event raised when any property is modified.
(Inherited from CAEXWrapper) |
Name | Description | |
---|---|---|
![]() | AddDocumentElement |
Adds a document element to the defined internalElement. A Document Element is semantically described
with an attached role defined with the base role class ExternalDataRoleClassPath or a
derived role class. If no role class path is given as a parameter the default is used. If the specified
role class path can not be identified as a derived role from the ExternalDataRoleClassPath
no document element is added (returns null).
(Defined by ExternalDataReference) |
![]() | AddInstance |
Inserts a new class instance to the InternalElement collection of the parentInternalElement. If there are existing
instances of the same Type, the Element is inserted after the last Element of that Type.
Before Insertion, the Uniqueness of the Name among the siblings of that Type is checked.
(Defined by SystemUnitClassTypeExtensions) |
![]() | AddNewInternalElement |
Creates a new InternalElement and inserts it after the last InternalElement of the
parent if the elementName is unique among the child's. The ChangeMode is set to the Value 'Create'
(Defined by SystemUnitClassTypeExtensions) |
![]() | AllLibraryReferences |
Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
![]() | AMLSystemUnitClass |
Converts an SystemUnitClassType to an AMLSystemUnitClass.
(Defined by AmlObjectsExtensions) |
![]() | Ancestors |
Returns all SystemUnit Classes which are ancestors of this SystemUnitClass. This SystemUnit Class is
included in the enumeration as the first Element, The farthest is the last Element in
the enumeration.
(Defined by AMLEngineAdapter) |
![]() | Append_InternalElement |
Inserts the InternalElement object after the defined Predecessor in the InternalElement
collection of the SystemUnitClass. If the Predecessor is null,
the InternalElement object is inserted at the first position of the InternalElement collection.
(Defined by SystemUnitClassTypeExtensions) |
![]() | AppendSignatureHeader |
This function appends a signature header to the provided CAEX object if it
does not exists. For an existing signature header the signature data is removed.
(Defined by CAEXSignatureHeader) |
![]() | AssignNewGUIDsAndRedirectExistingInternalLinks |
Assigns the new GUIds and redirect existing internal links.
(Defined by AMLEngineAdapter) |
![]() | AssignNewGUIDsAndRedirectExistingInternalLinksAndMirrorObjects |
This Method assigns new GUIds to the SystemUnitClass and its subordinate Children, which have an ID. The References
to the
old IDs in Mirrors and InternalLinks are redirected to the new ID. If a Reference is not found in any of the
subordinate
Elements, the Reference will not be changed.
(Defined by AMLEngineAdapter) |
![]() | AutomationMLEdition |
Gets the AutomationML edition of this caex object. The AutomationML edition is extracted
from the AutomationML filename, if it is coded in the name as defined in the library development
guide. If no edition is defined in the filename, the AutomationML version string is provided as
it is found in the AutomationML document.
(Defined by CAEXBasicObjectExtensions) |
![]() | clone | Copy(Boolean, Boolean, Boolean) (Defined by AMLEngineAdapter) |
![]() | CloneNode |
Clones the node.
(Defined by AMLEngineAdapter) |
![]() | ConsistencyCheck_ClassReference |
Check if the given classPath is a valid path to an existent class in the AML file.
(Defined by AMLEngineAdapter) |
![]() | Copy |
Copies the CAEX object and assigns the name to the created copy.
(Defined by CAEXObjectExtensions) |
![]() | DeleteSignature |
This function deletes the existing Signatures from the caex Object
(Defined by CAEXSignatureHeader) |
![]() | Descendants |
Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions) |
![]() | Descendants |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
![]() | DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
![]() | DocumentElements |
Gets all Internal Element Children from the specified internal element which
are document elements.
(Defined by ExternalDataReference) |
![]() | findInternalElement |
Resolve a reference to an InternalElement and return the referenced element if found.
(Defined by AMLEngineAdapter) |
![]() | getLinkedObjects |
Getting a List of LinkedObjects object of this SystemUnitClass containing references to the concrete referenced
InternalElements via an InternalLink.
(Defined by AMLEngineAdapter) |
![]() | getReferencedClass |
Getting the XML Node for a class path.
(Defined by AMLEngineAdapter) |
![]() | getReferencedGUID |
Parsing a string of form GUID:Interface and returning the GUID
(Defined by AMLEngineAdapter) |
![]() | getReferencedInterfaceClass |
Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations.
(Defined by AMLEngineAdapter) |
![]() | getReferencedInterfaceName |
Getting the name of the referenced Interface.
(Defined by AMLEngineAdapter) |
![]() | GetSignatureHeader |
Get the Additional Information XML-Node from the CAEX object, which represents
the Signature node.
(Defined by CAEXSignatureHeader) |
![]() | HasNewVersion |
Determines, if this caex object has a related newer version
(Defined by CAEXBasicObjectExtensions) |
![]() | HasOldVersion |
Determines, if this caex object has a related older version
(Defined by CAEXBasicObjectExtensions) |
![]() | Insert_Element |
Inserting an element of base type TypeBase to this object. The Element is inserted at the first Element
of any existing Elements of the same Type if nothing else is explicit defined.
(Defined by AMLEngineAdapter) |
![]() | Insert_InternalLink |
Inserts the specified InternalLink as the first InternalLink if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions) |
![]() | Insert_NewInstance |
Inserting a new class instance to this object. This method can be overridden in derived classes.
The Instance is inserted as the first instance of any other element with the same type if nothing
else is explicit defined.
(Defined by AMLEngineAdapter) |
![]() | Insert_SupportedRoleClass |
Inserts the SupportedRoleClass as the first SupportedRoleClass if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions) |
![]() | Insert_TypeBaseElement | Insert(CAEXWrapper, Boolean) (Defined by AMLEngineAdapter) |
![]() | InternalLinksToElement |
Gets all InternalLink referencing the provided SystemUnitClass object.
(Defined by QueryResult) |
![]() | Name |
Get the Name of the specified object.
(Defined by AMLEngineAdapter) |
![]() | Name |
Gets a names for the specified CAEX wrapper object. If the specified object is
a CAEXObject, the Name is returned; otherwise the TagName of the
CAEX item.
(Defined by CAEXBasicObjectExtensions) |
![]() | New_Description |
Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
![]() | New_InternalLink |
Inserts a new InternalLink as the first InternalLink if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions) |
![]() | New_SupportedRoleClass |
Inserts a new SupportedRoleClass as the first SupportedRoleClass if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions) |