Click or drag to resize

SystemUnitFamilyType Class

This Class is a wrapper for the CAEXElement 'SystemUnitFamilyType' which defines base structures for a hierarchical SystemUnitClass tree. The hierarchical structure has organizational character only. The class supports direct enumeration of the Tree.
Inheritance Hierarchy

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
public class SystemUnitFamilyType : SystemUnitClassType, 
	IInstantiable<InternalElementType>, IInstantiable, ICAEXObject, ICAEXBasicObject, 
	ICAEXWrapper, IXMLWrapper, ISystemUnitClassContainer, IEnumerable<SystemUnitFamilyType>, 
	IEnumerable, IClassWithBaseClassReference<SystemUnitFamilyType>, IClassWithBaseClassReference, IObjectWithAttributes, 
	IClassWithExternalInterface, IObjectWithExternalInterfaceAndInherited, IObjectWithExternalInterface, IObjectWithInheritedAttributes

The SystemUnitFamilyType type exposes the following members.

Constructors
 NameDescription
Public methodSystemUnitFamilyType Initializes a new instance of the SystemUnitFamilyType class.
Top
Properties
 NameDescription
Public propertyAdditionalInformation Gets the collection of AdditionalInformation values contained in this instance.
(Inherited from CAEXBasicObject)
Public propertyAttribute Gets the collection of Attribute objects for this instance.
(Inherited from SystemUnitClassType)
Public propertyAttributeAndDescendants Gets the attributes and all nested attributes.
(Inherited from SystemUnitClassType)
Public propertyAttributeAndInherited Gets the attributes and including all inherited attributes.
Public propertyBaseClass Gets and sets the BaseClass for this instance. According to CAEX, a class shall not inherit from itself or from a derivative of itself, therefore any cyclic reference is denied.
Public propertyCAEXDocument 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)
Public propertyCAEXParent Gets the CAEXParent of this instance if it exists.
(Inherited from CAEXWrapper)
Public propertyCAEXSequenceOfCAEXObject Gets the CAEXSequence containing this CAEX object
(Inherited from CAEXWrapper)
Public propertyChangeMode Gets and sets the change mode for a CAEX element (Optional in CAEX).
(Inherited from CAEXBasicObject)
Public propertyCopyright Gets and sets the Copyright for this object.
(Inherited from CAEXBasicObject)
Public propertyCopyrightElement Gets the wrapper for the Copyright element.
(Inherited from CAEXBasicObject)
Public propertyDescription Gets and sets the Description for this object.
(Inherited from CAEXBasicObject)
Public propertyDescriptionElement Gets the wrapper for the Description element.
(Inherited from CAEXBasicObject)
Public propertyDocument Gets the XDocument of the wrapped XML-Element
(Inherited from CAEXWrapper)
Public propertyExists Determines if this is a wrapper around an existing XML-Element
(Inherited from CAEXWrapper)
Public propertyExternalInterface Gets a collection of ExternalInterface objects contained in this instance.
(Inherited from SystemUnitClassType)
Public propertyExternalInterfaceAndDescendants Gets the collection of ExternalInterface objects including all nested descendant interfaces
(Inherited from SystemUnitClassType)
Public propertyExternalInterfaceAndInherited Gets the collection of ExternalInterface objects including all inherited interfaces
Public propertyID 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)
Public propertyInternalElement Gets the collection of InternalElement objects for this instance.
(Inherited from SystemUnitClassType)
Public propertyInternalElementAndInherited Gets the internal elements including the inherited elements from referenced base classes.
Public propertyInternalLink Gets the collection of InternalLink objects contained in this instance.
(Inherited from SystemUnitClassType)
Public propertyIsDeleted Determines, if this object is not contained in any document
(Inherited from CAEXWrapper)
Public propertyName Gets and sets the name of the CAEX object (required in CAEX).
(Inherited from CAEXObject)
Public propertyNode Gets the wrapped XML-Element
(Inherited from CAEXWrapper)
Public propertyOwner Gets the wrapped Xml-Element's parent
(Inherited from CAEXWrapper)
Public propertyRefBaseClassPath Gets and sets the path which references a base class. According to CAEX, a class shall not inherit from itself or from a derivative of itself, therefore any cyclic reference is denied.
Public propertyReference Gets the referenced class
(Inherited from CaexObjectWithReferenceT)
Public propertyReferenceAttributeName 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)
Public propertyReferencedClassName Gets the name (not the full path) of the referenced base class.
Public propertyRevision Gets the collection of Revision objects contained in this instance.
(Inherited from CAEXBasicObject)
Public propertyRoleReferences Gets all role references for the SystemUnitClass. The collection includes all RoleRequirement objects and SupportedRoleClass objects.
(Inherited from SystemUnitClassType)
Public propertyRoles Gets all role classes for the SystemUnitClass. The collection includes all RoleClasses, referenced by RoleRequirement objects and SupportedRoleClass objects.
(Inherited from SystemUnitClassType)
Public propertySourceObjectInformation Gets the collection of SourceObjectInformation objects contained in this instance.
(Inherited from CAEXBasicObject)
Public propertySupportedRoleClass Gets the collection of SupportedRoleClass objects contained in this instance.
(Inherited from SystemUnitClassType)
Public propertySystemUnitClass Gets a collection of SystemUnitClass objects of this instance.
Public propertyTagName Gets the name of the CAEX tag for this CAEX object.
(Inherited from CAEXWrapper)
Public propertyVersion Gets and sets the Version for this object.
(Inherited from CAEXBasicObject)
Public propertyVersionElement Gets the wrapper for the Version element.
(Inherited from CAEXBasicObject)
Top
Methods
 NameDescription
Public methodAddChild Appends a new element of the same type as this instance as a child element
(Inherited from CaexObjectWithReferenceT)
Public methodCode exampleAddInterfaceClassReference(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)
Public methodCode exampleAddInterfaceClassReference(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)
Public methodAddReference Adds a reference to the provided referenced class using the CAEXPath of the referenced class as the reference attribute value.
(Inherited from CaexObjectWithReferenceT)
Public methodCode exampleAddRoleClassReference(RoleFamilyType, Boolean) Adds a RoleClass reference to this SystemUnitClass object using the provided RoleClass object. The RoleClass reference is added as a SupportedRoleClassType object.
Public methodCode exampleAddRoleClassReference(String, Boolean) Adds a RoleClass reference to this SystemUnitClass object using the provided CAEX path, referencing a RoleClass object. The RoleClass reference is added as a SupportedRoleClassType object.
Public methodAssignNewGuidAsID Assigns the new unique identifier as a new ID to this CAEX object.
(Inherited from CAEXObject)
Public methodCAEXChild Gets the first child of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper)
Public methodCAEXChildren Gets all children of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper)
Public methodCAEXPath 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)
Public methodCAEXSequence Gets the CAEXSequence owned by this CAEX object, which contains the specified CAEX object.
(Overrides SystemUnitClassTypeCAEXSequence(ICAEXWrapper))
Public methodCanAddReference Determines if this CAEX object can reference the provided target CAEX object using the reference attribute.
(Inherited from CaexObjectWithReferenceT)
Public methodContainerT Gets the CAEX Container for elements of type T, which is owned by this CAEX object
(Overrides SystemUnitClassTypeContainerT)
Public methodCopy 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)
Public methodCreateClassInstance Creates an InternalElement as an instance of this class. All References to Base classes are resolved.
Public methodEquals Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper)
Public methodGetEnumerator Gets the Enumerator for the enumeration of the SystemUnitClass field.
Public methodGetHashCode Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper)
Public methodGetInheritedSupportedRoles Gets a collection of SupportedRoleClasses objects of this SystemUnitClass and of all inherited BaseClasses. Duplicates are removed from the result.
Public methodGetReferencedSystemUnitClass Getting a referenced SystemUnitClass.
Public methodGetReferenceHierarchy Gets the reference (Inheritance) hierarchy including this instance in an ordered sequence of ancestors.
Public methodGetReferenceHierarchyTObsolete.
Gets the reference (Inheritance) hierarchy including this instance in an ordered sequence of ancestors.
Public methodGetXAttributeValue Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element.
(Inherited from CAEXWrapper)
Public methodHasGenericRoleClassReference(RoleFamilyType) Determines whether the specified RoleClass is more specific than any already associated RoleClass of this SystemUnitClass. This method doesn't check inherited RoleClass references from ancestors. If an assigned RoleClass is identical to the specified RoleClass, the result is false.
Public methodHasGenericRoleClassReference(RoleRequirementsType) Determines whether the specified roleReference is more specific than any already associated SupportedRoleClass of this SystemUnitClass. This method doesn't check inherited RoleClass references from ancestors. If an assigned RoleClass is identical to the specified RoleClass, the result is false.
Public methodCode exampleHasInterfaceClassReference 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)
Public methodCode exampleHasRoleClassReference(RoleFamilyType, Boolean) Determines whether this SystemUnitClass object has a SupportedRoleClass with a reference to the specified RoleClass. If inheritance relations between role classes should be regarded, the optional parameter 'regardInheritance' should be set. In this case the specified RoleClass is either identical to a referenced RoleClass or a referenced RoleClass is derived from the specified RoleClass. Independently of the regardInheritanceOfRoleClasses value, always the Role assignments to this SystemUnitClass and any ancestors of this SystemUnitClass are checked, using the GetInheritedSupportedRoles method.
Public methodCode exampleHasRoleClassReference(String, Boolean) Determines whether this SystemUnitClass object has a SupportedRoleClass with the specified CAEX path reference. If inheritance relation should be regarded, the optional parameter 'regardInheritance' should be set.
Public methodImport 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.
(Overrides SystemUnitClassTypeImport(CAEXWrapper, String, Boolean))
Public methodInsert(CAEXWrapper, Boolean) Inserts the specified CAEX object in it's associated sequence. The SystemUnitFamilyType defines the SystemUnitClass sequence.
(Overrides SystemUnitClassTypeInsert(CAEXWrapper, Boolean))
Public methodInsert(Int32, CAEXWrapper) Inserts the specified CAEX object in it's associated sequence. The SystemUnitFamilyType defines the SystemUnitClass sequence.
(Overrides SystemUnitClassTypeInsert(Int32, CAEXWrapper))
Public methodInsertAfter(T) Inserts the provided CAEX object as a new sibling after this CAEX object.
(Inherited from CaexObjectWithReferenceT)
Public methodInsertAfter(InternalElementType) Inserts the provided CAEX object as a new sibling after this CAEX object.
(Inherited from SystemUnitClassType)
Public methodInsertBefore(T) Inserts the provided CAEX object as a new sibling before this CAEX object.
(Inherited from CaexObjectWithReferenceT)
Public methodInsertBefore(InternalElementType) Inserts the provided CAEX object as a new sibling before this CAEX object.
(Inherited from SystemUnitClassType)
Public methodInsertNew 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)
Public methodLowestCommonParent 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)
Public methodNew_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)
Public methodRemove Removes this SystemUnitClass from the document.
(Overrides CAEXWrapperRemove(Boolean))
Public methodReplaceRoleClassReference Replaces an existing role class reference to the provided role or a generic base role of the provided role by a new instance of the role class.
Public methodSetXAttributeValue Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null).
(Inherited from CAEXWrapper)
Public methodSupportedRoleClassWithName Get the RoleClass from the sequence of SupportedRoleClass with the provided roleClassName.
(Inherited from SystemUnitClassType)
Public methodToString Returns the value of the 'Name' attribute of this CAEX object as the string representation of the object.
(Inherited from CAEXObject)
Top
Events
 NameDescription
Public eventPropertyChanged The Change event raised when any property is modified.
(Inherited from CAEXWrapper)
Top
Extension Methods
 NameDescription
Public Extension MethodCode exampleAddAttributeTypeReference Adds an AttributeType reference to this ObjectWithAttribute using the provided AttributeType object. The AttributeType reference is added as a AttributeType object.
(Defined by ObjectWithAttributes)
Public Extension MethodCode exampleAddAttributeTypeReference Adds an AttributeType reference to this ObjectWithAttribute using the provided CAEX path, referencing an AttributeType object. The AttributeType reference is added as a AttributeType object.
(Defined by ObjectWithAttributes)
Public Extension MethodAddChildWithReferenceSystemUnitFamilyType Appends a new element of the same type as a child element and adds a reference from the child to this element.
(Defined by ObjectWithBaseClass)
Public Extension MethodAddDocumentElement 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)
Public Extension MethodAddInstance 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)
Public Extension MethodCode exampleAddInterfaceClassReference Adds an InterfaceClass reference to this ObjectWithExternalInterface using the provided InterfaceClass object. The InterfaceClass reference is added as a ExternalInterfaceType object.
(Defined by ObjectWithExternalInterface)
Public Extension MethodCode exampleAddInterfaceClassReference Adds an InterfaceClass reference to this ObjectWithExternalInterface using the provided CAEX path, referencing an InterfaceClass object. The InterfaceClass reference is added as a ExternalInterfaceType object.
(Defined by ObjectWithExternalInterface)
Public Extension MethodAddNewInternalElement 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)
Public Extension MethodAllLibraryReferences Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodAMLAttributes Conversion of any object which has an attribute collection to get access to specific AutomationML defined attributes.
(Defined by AmlObjectsExtensions)
Public Extension MethodAMLSchemaManager Gets the associated CAEX schema manager of the CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodAMLSystemUnitClass Converts an SystemUnitClassType to an AMLSystemUnitClass.
(Defined by AmlObjectsExtensions)
Public Extension MethodAncestors Returns all SystemUnit Classes which are ancestors of this. This SystemUnit Class is included in the enumeration as the first Element, The farthest is the last Element in the enumeration.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodAncestors 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)
Public Extension MethodAncestors Finds all ancestors of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodAncestorsT Finds the ancestors of the provided CAEX object which have the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodAppend_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)
Public Extension MethodAppendSignatureHeader 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)
Public Extension MethodAssignNewGUIDsAndRedirectExistingInternalLinks Assigns the new GUIds and redirect existing internal links.
(Defined by AMLEngineAdapter)
Public Extension MethodAssignNewGUIDsAndRedirectExistingInternalLinksAndMirrorObjects 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)
Public Extension MethodAttributes Enumeration Method for direct Children of Type AttributeType
(Defined by AMLEngineAdapter)
Public Extension MethodAutomationMLEdition 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)
Public Extension MethodCAEXDocument Gets the CAEX document which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodCAEXFile Gets the CAEX file which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodCAEXSchema Gets the associated CAEX schema of the CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodChangeNameAndReferencesSystemUnitFamilyType Changes the name of the CAEX class and all the references to the class in the whole CAEX document.
(Defined by InheritanceExtensions)
Public Extension MethodClassIsDerivedFromSystemUnitFamilyType Determines, if the specified class is directly or indirectly (across multiple generations) a descendant of the specified base class or identical to it. This method can be used, if the classes are distributed over different CAEX documents, the documents should be referenced by external references and alias references.
(Defined by InheritanceExtensions)
Public Extension MethodClassIsDerivedFromSystemUnitFamilyType Determines, if the specified class is directly or indirectly (across multiple generations) a descendant of the class or identical to it, which is uniquely identified with the specified baseClass path. The base class path or the referenced class path may contain alias identifiers. If alias identifiers are present, the method tries to load the external referenced document.
(Defined by InheritanceExtensions)
Public Extension MethodcloneCopy(Boolean, Boolean, Boolean)
(Defined by AMLEngineAdapter)
Public Extension MethodCloneNode Clones the node.
(Defined by AMLEngineAdapter)
Public Extension MethodConsistencyCheck_ClassReference Check if the given classPath is a valid path to an existent class in the AML file.
(Defined by AMLEngineAdapter)
Public Extension MethodCopy Copies the CAEX object and assigns the name to the created copy.
(Defined by CAEXObjectExtensions)
Public Extension MethodCopyAttributesFrom Copies all attribute of the source object with attributes to the target object including children
(Defined by ObjectWithAttributes)
Public Extension MethodCopyTreeAndChangeReferencesSystemUnitFamilyType Creates a copy of the source class and all its child classes and assigns the provided name to the copy. Including references to objects in the original class tree are redirected to objects in the copied tree. The copy is inserted into the provided parent object.
(Defined by InheritanceExtensions)
Public Extension MethodCreateClassInstanceInternalElementType Creates a class instance of the CAEX class and assigns the name to the instance.
(Defined by InheritanceExtensions)
Public Extension MethodCreateListAttribute Creates a new list attribute for an element which can have attributes.
(Defined by ListAttribute)
Public Extension MethodDeleteInheritedElement Deletes the inherited element. According to CAEX [DIN EN 62424:2008-08 A.2.4.1 (pp.48-49)], deleting of inherited properties is possible by redefinition of the corresponding data again in the child object with the ChangeMode attribute set to "deleted".
(Defined by ObjectWithBaseClass)
Public Extension MethodDeleteSignature This function deletes the existing Signatures from the caex Object
(Defined by CAEXSignatureHeader)
Public Extension MethodDescendants Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendants Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendantsT Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendantsT Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDocumentElements Gets all Internal Element Children from the specified internal element which are document elements.
(Defined by ExternalDataReference)
Public Extension MethodExternalInterfaces Enumeration Method for direct Children of Type InterfaceClassType
(Defined by AMLEngineAdapter)
Public Extension MethodFindCaexObjectFromIdT Finds the CAEX object with the specified id and the specified Type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodfindExternalInterface Searches for an ExternalInterface in this InternalElement
(Defined by AMLEngineAdapter)
Public Extension MethodfindInternalElement Resolve a reference to an InternalElement and return the referenced element if found.
(Defined by AMLEngineAdapter)
Public Extension MethodFindReferencedClassT Finds the CAEX object with the specified CAEX path and the specified Type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodFirstAncestor Finds the first ancestor of the specified CAEX object which fulfils the specified predicate
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodFirstAncestor Finds the first ancestor of the specified CAEX object with the given Tag name
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodFirstAncestorT Finds the first ancestor of the specified CAEX object in the given Type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodFrameAttribute Gets a defined FrameAttribute from the Attribute collection of the IObjectWithAttributes. If no such attribute exists, null is returned.
(Defined by AmlObjectsExtensions)
Public Extension MethodGetAttribute Gets the first attribute with the specified name from the attribute collection of the CAEX object.
(Defined by ObjectWithAttributes)
Public Extension MethodgetAttributeField Get the whole attribute field containing a collection of all attributes of this object.
(Defined by AMLEngineAdapter)
Public Extension MethodGetAttributeValue Returns an attribute value of a given attribute name.
(Defined by AMLEngineAdapter)
Public Extension MethodGetDerivedAttributes Gets a list of Attribute objects that are inherited from base classes. The List will also contain the elements own Attribute objects, if the parameter is set (default). If an Attribute is overwritten, only the last defined is contained.
(Defined by ObjectWithBaseClass)
Public Extension MethodGetDerivedInterfaces Gets a list of ExternalInterface objects that are inherited from base classes. The List will also contain the elements own ExternalInterface objects, if the parameter is set (default). If an ExternalInterface is overwritten, only the last defined is contained.
(Defined by ObjectWithBaseClass)
Public Extension MethodGetDerivedSupportedRoles Gets the supported Roles and the inherited roles from base classes.
(Defined by SystemUnitFamilyTypeExtensions)
Public Extension MethodGetExternalInterfaces Gets the external interfaces.
(Defined by AMLEngineAdapter)
Public Extension MethodGetFullNodePath Gets the full node path of the provided CAEX object, which includes the object names of all ancestor hierarchy levels and the name of the object itself.
(Defined by CAEXObjectExtensions)
Public Extension MethodGetInheritedAttributes Gets a collection of Attribute objects that are inherited from base classes. The own attributes are included in the enumeration.
(Defined by ObjectWithBaseClass)
Public Extension MethodGetInheritedAttributesAndDescendants Gets a list of Attribute objects that are inherited from base classes. The List will also contain the elements own Attribute objects, if the parameter is set (default). If an Attribute is overwritten, only the last defined is contained.
(Defined by ObjectWithBaseClass)
Public Extension MethodGetInheritedElements Gets a collection of InternalElement objects that are inherited from base classes. As default, the own InternalElements are included in the enumeration.
(Defined by ObjectWithBaseClass)
Public Extension MethodGetInheritedInterfaces Gets a collection of ExternalInterface objects that are inherited from base classes.
(Defined by ObjectWithBaseClass)
Public Extension MethodGetInheritedInterfacesAndDescendants Gets a list of ExternalInterface objects that are inherited from base classes. The List will also contain the elements own ExternalInterface objects, if the parameter is set (default). If an ExternalInterface is overridden, only the last defined is contained. The result also contains the nested interface descendants of an external interface.
(Defined by ObjectWithBaseClass)
Public Extension MethodgetLinkedObjects Getting a List of LinkedObjects object of this SystemUnitClass containing references to the concrete referenced InternalElements via an InternalLink.
(Defined by AMLEngineAdapter)
Public Extension MethodGetParentT Tries to get a CAEX parent with the specified Type of the provided caexObject. If the parent is not assignable to the provided type, the result is null.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodgetReferencedClass Getting the XML Node for a class path.
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedGUID Parsing a string of form GUID:Interface and returning the GUID
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedInterfaceClass Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations.
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedInterfaceName Getting the name of the referenced Interface.
(Defined by AMLEngineAdapter)
Public Extension MethodGetSignatureHeader Get the Additional Information XML-Node from the CAEX object, which represents the Signature node.
(Defined by CAEXSignatureHeader)
Public Extension MethodCode exampleHasInterfaceClassReference Determines whether an object with ExternalInterfaces 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.
(Defined by ObjectWithExternalInterface)
Public Extension MethodCode exampleHasInterfaceClassReference Determines whether this Object with ExternalInterfaces has an associated InterfaceClass reference with the specified CAEX path interface reference. If inheritance relations between interface classes 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.
(Defined by ObjectWithExternalInterface)
Public Extension MethodHasNewVersion Determines, if this caex object has a related newer version
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodHasOldVersion Determines, if this caex object has a related older version
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodInheritedElementsTInheritedElement Gets a collection of objects of the defined InheritedElement-Type that are inherited from base classes.
(Defined by ObjectWithBaseClass)
Public Extension MethodInsert_Attribute Inserts an Attribute object in the Attribute collection of the objectWithAttributes.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodInsert_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)
Public Extension MethodInsert_ExternalInterface Inserting an ExternalInterface to the ExternalInterface-Collection of the objectWithExternalInterface. The Element is inserted at the first Element of any existing ExternalInterfaces if no other position is defined.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodInsert_InternalLink Inserts the specified InternalLink as the first InternalLink if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodInsert_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)
Public Extension MethodInsert_SupportedRoleClass Inserts the SupportedRoleClass as the first SupportedRoleClass if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodInsert_SystemUnitClass Inserts the provided SystemUnitClass object as a subordinate child into this SystemUnitClass
(Defined by SystemUnitFamilyTypeExtensions)
Public Extension MethodInsert_SystemUnitFamilyType Appending the systemUnitFamilyType object into this object.
(Defined by AMLEngineAdapter)
Public Extension MethodInsert_TypeBaseElementInsert(CAEXWrapper, Boolean)
(Defined by AMLEngineAdapter)
Public Extension MethodInterfaceClassReferences All external Interfaces of this Object with ExternalInterfaces with an associated InterfaceClass reference with the specified CAEX path interface reference. If inheritance relations between interface classes 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.
(Defined by ObjectWithExternalInterface)
Public Extension MethodInternalLinksToElement Gets all InternalLink referencing the provided SystemUnitClass object.
(Defined by QueryResult)
Public Extension MethodIsAMLObject Determines whether the CAEX object is an AutomationML object. If the CAEX object is a SystemUnitClass or InternalElement, it is checked, if there exists a role reference to the AutomationMLBaseRole. If the CAEX object is an ExternalInterface, it is checked, if there exists an InterfaceClass reference to an AutomationMLBase Interface.
(Defined by AmlObjectsExtensions)
Public Extension MethodIsInherited Determines, if the specified element is an inherited element. To be an inherited element, it has to be an AttributeType, ExternalInterfaceType or InternalElementType element.
(Defined by ObjectWithBaseClass)
Public Extension MethodIsOverridden Determines, if an element of a class with an inheritance relation to a base class is an overridden element, what means a base class contains an element which is considered as equal to the provided element. In most cases, equality is defined by equality of the element names.
(Defined by ObjectWithBaseClass)
Public Extension MethodLibrary Gets the Library which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodName Get the Name of the specified object.
(Defined by AMLEngineAdapter)
Public Extension MethodName 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)
Public Extension MethodNew_Attribute Appends a new Attribute object with the defined name to the specified CAEX object.
(Defined by ObjectWithAttributes)
Public Extension MethodNew_Copyright Adds an new Copyright node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodNew_Description Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodNew_ExternalInterface Adding a new ExternalInterface instance to the ExternalInterface-Collection of the objectWithExternalInterface. The New ExternalInterface is inserted as the first ExternalInterface of any existing Interfaces if nothing else is explicit defined.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodNew_ExternalInterface Adding a new ExternalInterface instance to the ExternalInterface-Collection of the objectWithExternalInterface referencing a specific InterfaceClass. The New ExternalInterface is inserted as the first ExternalInterface of any existing Interfaces if nothing else is explicit defined. The provided interfaceClassPath is set as the RefBaseClassPath value.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodNew_FrameAttribute Creates a new Frame attribute for the IObjectWithAttributes if no Frame attribute exists. The provided values are used to initialize the Frame attribute values.
(Defined by AmlObjectsExtensions)
Public Extension MethodNew_InternalLink Inserts a new InternalLink as the first InternalLink if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodNew_SupportedRoleClass Inserts a new SupportedRoleClass as the first SupportedRoleClass if nothing else if explicit defined.
(Defined by SystemUnitClassTypeExtensions)
Public Extension MethodNew_SystemUnitClass Adding a new SystemUnitClass to this SystemUnitFamily.
(Defined by SystemUnitFamilyTypeExtensions)
Public Extension MethodNew_Version Adds an new Version node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodOfInterfaceClass Gets all ExternalInterface objects from the specified objectWithExternalInterface, which are derived from an InterfaceClass, identified with the given interfaceClassPath.
(Defined by ExternalInterfaceTypeExtensions)
Public Extension MethodOverriddenElement Determines, if an element of a class with an inheritance relation to a base class has an overridden element with the specified name and type, what means a base class contains an element which name is equal to the provided elementName.
(Defined by ObjectWithBaseClass)
Public Extension MethodReferencedClassName Name of the referenced Class without path information.
(Defined by ObjectWithBaseClass)
Public Extension MethodRefTypeAttribute Gets the RefTypeAttributeTypefrom the objectWithAttributes if one exists. This Attribute is defined for a COLLADAInterface.
(Defined by AmlObjectsExtensions)
Public Extension MethodRefURIAttribute Gets the RefURIAttributeType from the objectWithAttributes if one exists.
(Defined by AmlObjectsExtensions)
Public Extension MethodSetAttributeValue Sets a value for the attribute from a string with the specified name from the attribute collection of the CAEX object. If no attribute with that name exists, it is created.
(Defined by ObjectWithAttributes)
Public Extension MethodCode exampleSetAttributeValue Modifies the attribute with the specified name from the attribute collection of the CAEX object, using the provided double value. If no attribute with that name exists, it is created. Sets the AttributeDataType to xs:double. To change existing attributes it is recommended to use indexers (see examples below).
(Defined by ObjectWithAttributes)
Public Extension MethodSetAttributeValue Modifies the attribute with the specified name from the attribute collection of the CAEX object, using the provided values. If no attribute with that name exists, it is created.
(Defined by ObjectWithAttributes)
Public Extension MethodSetAttributeValue Modifies the attribute with the specified name from the attribute collection of the CAEX object, using the provided values. If no attribute with that name exists, it is created. Sets the AttributeDataType to xs:double
(Defined by ObjectWithAttributes)
Public Extension MethodSetAttributeValue Modifies the attribute with the specified name from the attribute collection of the CAEX object, using the provided values. If no attribute with that name exists, it is created.
(Defined by ObjectWithAttributes)
Public Extension MethodSetAttributeValueT Sets a typed value for the attribute with the specified name from the attribute collection of the CAEX object. If no attribute with that name exists, it is created. The correct encoding for the attribute value xml representation is automatically defined.
(Defined by ObjectWithAttributes)
Public Extension MethodSetDescription This method sets a description. If no description exists, it is created.
(Defined by CAEXObjectExtensions)
Public Extension MethodSystemUnitClassChildren Gets all Children SystemUnitFamilyType Objects of this SystemUnitClass.
(Defined by AMLEngineAdapter)
Public Extension MethodSystemUnitClassDescendants Gets all descendant SystemUnitFamilyType Objects in the SystemUnitClass. SystemUnitClasses on all levels are returned.
(Defined by SystemUnitFamilyTypeExtensions)
Top
Explicit Interface Implementations
 NameDescription
Explicit interface implementationPrivate methodIEnumerableGetEnumerator Gets the Enumerator for the enumeration of the SystemUnitClass field.
Explicit interface implementationPrivate methodIInstantiableCreateClassInstance Creates an InternalElement as an instance of this class. All References to Base classes are resolved.
Top
See Also