IInterfaceMapping Interface

Since CAEX 3.0 a new definition has been added to model Interface mappings using the ID of the mapped ExternalInterface. This Interface has been designed, to support InterfaceMapping access to the CAEX documents, defined using prior schema versions.

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

Syntax

C++

Copy

public interface IInterfaceMapping : IMapping, 
	ICAEXBasicObject, ICAEXWrapper, IXMLWrapper

Public Interface IInterfaceMapping
	Inherits IMapping, ICAEXBasicObject, ICAEXWrapper, IXMLWrapper

public interface class IInterfaceMapping : IMapping, 
	ICAEXBasicObject, ICAEXWrapper, IXMLWrapper

The IInterfaceMapping type exposes the following members.

Properties

	Name	Description
	AdditionalInformation	Gets the collection of AdditionalInformation values contained in this instance. (Inherited from ICAEXBasicObject)
	CAEXParent	Gets the CAEXParent of this CAEX object (Inherited from ICAEXWrapper)
	ChangeMode	Gets and sets the change mode for a CAEX element (Optional in CAEX). (Inherited from ICAEXBasicObject)
	Copyright	Gets and sets the Copyright for this object. (Inherited from ICAEXBasicObject)
	CopyrightElement	Gets the wrapper for the Copyright element. (Inherited from ICAEXBasicObject)
	Description	Gets and sets the Description for this object. (Inherited from ICAEXBasicObject)
	DescriptionElement	Gets the wrapper for the Description element. (Inherited from ICAEXBasicObject)
	Document	Gets the XDocument containing the XML node of this object. If the object has not been inserted into a document, the XDocument is null. Direct manipulations of the XML document are not monitored by the AML engine. (Inherited from IXMLWrapper)
	Exists	Determines, if this instance is wrapped around an existing XML node (Inherited from IXMLWrapper)
	MappingObject	Gets the mapping object which contains this Mapping Element. (Inherited from IMapping)
	Node	Get the XML node of this instance. Direct manipulations of the XML node are not monitored by the AML engine. (Inherited from IXMLWrapper)
	Owner	Gets the XML parent node of this instance. Direct manipulations of the XML node are not monitored by the AML engine. (Inherited from IXMLWrapper)
	Revision	Gets the collection of Revision objects contained in this instance. (Inherited from ICAEXBasicObject)
	RoleInterface	Gets and sets the mapped ExternalInterface of the role reference
	SourceObjectInformation	Gets the collection of SourceObjectInformation objects contained in this instance. (Inherited from ICAEXBasicObject)
	SystemUnitInterface	Gets and sets the mapped ExternalInterface of the SystemUnitClass
	TagName	Gets the Schema Tag name of this instance. (Inherited from IXMLWrapper)
	Version	Gets and sets the Version for this object. (Inherited from ICAEXBasicObject)
	VersionElement	Gets the wrapper for the Version element. (Inherited from ICAEXBasicObject)

Top

Methods

	Name	Description
	CAEXChild	Gets the first child of this CAEX object with the defined CAEX tag name. (Inherited from ICAEXWrapper)
	CAEXChildren	Gets all children of this CAEX object with the defined CAEX tag name. (Inherited from ICAEXWrapper)
	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 ICAEXBasicObject)
	ContainerT	Gets the CAEXSequence for elements of type T, which is owned by this CAEX object. (Inherited from ICAEXBasicObject)
	Insert(CAEXWrapper, Boolean)	Inserts the specified CAEX object in it's associated sequence. The CAEXBasicObject defines the Revision and SourceObjectInformation sequences. (Inherited from ICAEXBasicObject)
	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 ICAEXBasicObject)
	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 ICAEXBasicObject)
	Remove	Removes this object (Inherited from ICAEXWrapper)

Top

Extension Methods

	Name	Description
	AMLSchemaManager	Gets the associated CAEX schema manager of the CAEX object. (Defined by CAEXBasicObjectExtensions)
	Ancestors	Finds all ancestors of the provided CAEX object. (Defined by CAEXBasicObjectExtensions)
	AncestorsT	Finds the ancestors of the provided CAEX object which have the given type. (Defined by CAEXBasicObjectExtensions)
	CAEXDocument	Gets the CAEX document which contains this CAEX object. (Defined by CAEXBasicObjectExtensions)
	CAEXFile	Gets the CAEX file which contains this CAEX object. (Defined by CAEXBasicObjectExtensions)
	CAEXSchema	Gets the associated CAEX schema of the CAEX object. (Defined by CAEXBasicObjectExtensions)
	DescendantsT	Finds the descendants of the provided CAEX object which are of the given type. (Defined by CAEXBasicObjectExtensions)
	FindCaexObjectFromIdT	Finds the CAEX object with the specified id and the specified Type. (Defined by CAEXBasicObjectExtensions)
	FindReferencedClassT	Finds the CAEX object with the specified CAEX path and the specified Type. (Defined by CAEXBasicObjectExtensions)
	FirstAncestor	Finds the first ancestor of the specified CAEX object which fulfils the specified predicate (Defined by CAEXBasicObjectExtensions)
	FirstAncestor	Finds the first ancestor of the specified CAEX object with the given Tag name (Defined by CAEXBasicObjectExtensions)
	FirstAncestorT	Finds the first ancestor of the specified CAEX object in the given Type. (Defined by CAEXBasicObjectExtensions)
	GetParentT	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)
	IsAMLObject	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)
	Library	Gets the Library which contains this CAEX object. (Defined by CAEXBasicObjectExtensions)
	New_Copyright	Adds an new Copyright node to this object if it doesn't exists. (Defined by CAEXBasicObjectExtensions)
	New_Version	Adds an new Version node to this object if it doesn't exists. (Defined by CAEXBasicObjectExtensions)

Top

Reference

Aml.Engine.CAEX Namespace

IMapping