AttributeNameMappingType Class

This class is a wrapper for the CAEX element 'AttributeNameMapping' which defines mappings between attributes of an AML object and any associated role class.

Inheritance Hierarchy

SystemObject
  Aml.Engine.CAEXCAEXWrapper
    Aml.Engine.CAEXCAEXBasicObject
      Aml.Engine.CAEXMappingElementTypeAttributeType
        Aml.Engine.CAEXAttributeNameMappingType

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

public class AttributeNameMappingType : MappingElementType<AttributeType>

Public Class AttributeNameMappingType
	Inherits MappingElementType(Of AttributeType)

public ref class AttributeNameMappingType : public MappingElementType<AttributeType^>

The AttributeNameMappingType type exposes the following members.

Constructors

	Name	Description
	AttributeNameMappingType	Creates a wrapper for the specified XElement which is an AttributeNameMapping Element

Top

Properties

	Name	Description
	AdditionalInformation	Gets the collection of AdditionalInformation values contained in this instance. (Inherited from CAEXBasicObject)
	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)
	IsDeleted	Determines, if this object is not contained in any document (Inherited from CAEXWrapper)
	MappingObject	Gets the mapping object which contains this Mapping Element. (Inherited from MappingElementTypeT)
	MappingRoleClass	Gets the RoleClass, which provides the RoleClassMappingElements(Boolean). (Inherited from MappingElementTypeT)
	MappingRoleReference	Gets the Role reference, which can provide additional RoleClassMappingElements(Boolean). (Inherited from MappingElementTypeT)
	MappingSystemUnitClass	Gets the SystemUnitClass, which provides the SystemUnitClassMappingElements. (Inherited from MappingElementTypeT)
	Node	Gets the wrapped XML-Element (Inherited from CAEXWrapper)
	Owner	Gets the wrapped Xml-Element's parent (Inherited from CAEXWrapper)
	Revision	Gets the collection of Revision objects contained in this instance. (Inherited from CAEXBasicObject)
	RoleAttribute	Gets the RoleClass element which can be identified with the RoleAttributeName or sets the RoleAttributeName retrieved from the provided value.
	RoleAttributeName	Gets and Sets the 'RoleAttributeName' for this instance
	RoleClassElement	Gets the RoleClass element which can be identified with the RoleClassElementIdentifier or sets the RoleClassElementIdentifier extracted from the provided CAEXObject which shall be an AttributeType for an attribute mapping or an ExternalInterfaceType for an interface mapping. If the provided CAEXobject is not applicable for the Mapping, the RoleClassElementIdentifier is not changed. (Inherited from MappingElementTypeT)
	RoleClassElementIdentifier	Gets and sets the identifier for the mapped RoleClass element. (Overrides MappingElementTypeTRoleClassElementIdentifier)
	SourceObjectInformation	Gets the collection of SourceObjectInformation objects contained in this instance. (Inherited from CAEXBasicObject)
	SystemUnitAttribute	Gets or sets the system unit attribute which is defined using the CAEX attribute SystemUnitAttributeName.
	SystemUnitAttributeName	Gets and Sets the 'SystemUnitAttributeName' for this instance
	SystemUnitClassElement	Gets the SystemUnitClass element which can be identified with the SystemUnitClassElementIdentifier or sets the SystemUnitClassElementIdentifier defined by the provided value. (Inherited from MappingElementTypeT)
	SystemUnitClassElementIdentifier	Gets or sets the identifier for the mapped SystemUnitClass element. (Overrides MappingElementTypeTSystemUnitClassElementIdentifier)
	SystemUnitClassMappingElements	Gets the collection of SystemUnitClass Mapping elements (Overrides MappingElementTypeTSystemUnitClassMappingElements)
	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)

Top

Methods

	Name	Description
	AddRoleClassElement	This method is an extension to the RoleClassElement setter in case of MultipleRole assignments in AutomationML 2.0 based on CAEX 2.15. The method can assign a qualified RoleClassElement as a mapping element and will eventually create a missing RoleRequirement element for the qualified element. For Documents, based on CAEX 3.0 the behaviour of this method is identical to the RoleClassElement setter. (Inherited from MappingElementTypeT)
	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)
	CAEXSequence	Gets the CAEXSequence owned by this instance, which contains the specified CAEX object. For example, if the specified object is a revision object, the sequence of the revision objects Revision is returned. (Inherited from CAEXBasicObject)
	ContainerT	Gets the CAEX Container for elements of type T, which is owned by this CAEX object (Inherited from CAEXBasicObject)
	Copy	Creates a deep copy of this CAEX object (Inherited from CAEXWrapper)
	Equals	Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements. (Inherited from CAEXWrapper)
	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)
	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 CAEXBasicObject)
	Insert(CAEXWrapper, Boolean)	Inserts the specified CAEX object in it's associated sequence. The CAEXBasicObject defines the Revision and SourceObjectInformation sequences. (Inherited from CAEXBasicObject)
	Insert(Int32, CAEXWrapper)	Inserts the specified CAEX object in it's associated sequence at the defined position. The CAEXBasicObject defines the Revision and SourceObjectInformation sequences. (Inherited from CAEXBasicObject)
	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)
	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)
	RoleClassMappingElements	Gets the collection of possible mapping identifiers for this AttributeNameMappingType for elements of the mapped RoleClass. The Collection contains all attributes (including inherited attributes) of the RoleClass and also the attributes of the ExternalInterfaces (including inherited external interfaces) of the RoleClass. The Attribute Identifiers are the unique CAEXPath's of the attributes relative to the RoleClass. (Overrides MappingElementTypeTRoleClassMappingElements(Boolean))
	SetXAttributeValue	Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null). (Inherited from CAEXWrapper)

Top

Events

	Name	Description
	PropertyChanged	The Change event raised when any property is modified. (Inherited from CAEXWrapper)

Top

Extension Methods

	Name	Description
	AllLibraryReferences	Gets all libraries which are referenced by this CAEX object. (Defined by CAEXBasicObjectExtensions)
	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)
	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)
	findInternalElement	Resolve a reference to an InternalElement and return the referenced element if found. (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)
	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_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_TypeBaseElement	Insert(CAEXWrapper, Boolean) (Defined by AMLEngineAdapter)
	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)

Top

Reference

Aml.Engine.CAEX Namespace

CAEXBasicObject