IClassWithExternalInterface Interface

Interface that defines methods and properties that apply to all classes that are able to contain ExternalInterface objects.

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

Syntax

C++

Copy

public interface IClassWithExternalInterface : IClassWithBaseClassReference, 
	IObjectWithAttributes, ICAEXWrapper, IXMLWrapper, ICAEXObject, ICAEXBasicObject, 
	IObjectWithExternalInterfaceAndInherited, IObjectWithExternalInterface

Public Interface IClassWithExternalInterface
	Inherits IClassWithBaseClassReference, IObjectWithAttributes, ICAEXWrapper, IXMLWrapper, 
	ICAEXObject, ICAEXBasicObject, IObjectWithExternalInterfaceAndInherited, IObjectWithExternalInterface

public interface class IClassWithExternalInterface : IClassWithBaseClassReference, 
	IObjectWithAttributes, ICAEXWrapper, IXMLWrapper, ICAEXObject, ICAEXBasicObject, 
	IObjectWithExternalInterfaceAndInherited, IObjectWithExternalInterface

The IClassWithExternalInterface type exposes the following members.

Properties

	Name	Description
	AdditionalInformation	Gets the collection of AdditionalInformation values contained in this instance. (Inherited from ICAEXBasicObject)
	Attribute	Get the collection of all attributes of this object. Inherited Attributes are not included. (Inherited from IObjectWithAttributes)
	AttributeAndDescendants	Gets the attributes and all nested attributes. (Inherited from IObjectWithAttributes)
	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)
	ExternalInterface	Gets the collection of ExternalInterface objects (Inherited from IObjectWithExternalInterface)
	ExternalInterfaceAndDescendants	Gets the collection of ExternalInterface objects including all nested descendant interfaces (Inherited from IObjectWithExternalInterface)
	ExternalInterfaceAndInherited	Gets the collection of ExternalInterface objects including all inherited interfaces (Inherited from IObjectWithExternalInterfaceAndInherited)
	ID	Gets or sets the identifier. (Inherited from ICAEXObject)
	Name	Gets or sets the name. (Inherited from ICAEXObject)
	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)
	RefBaseClassPath	Gets the reference base class path. (Inherited from IClassWithBaseClassReference)
	ReferencedClassName	Gets the name (not the full path) of the referenced base class. (Inherited from IClassWithBaseClassReference)
	Revision	Gets the collection of Revision objects contained in this instance. (Inherited from ICAEXBasicObject)
	SourceObjectInformation	Gets the collection of SourceObjectInformation objects contained in this instance. (Inherited from ICAEXBasicObject)
	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)
	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 ICAEXObject)
	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)
	GetReferenceHierarchyT	Gets the reference (inheritance relations) hierarchy including the actual class as a queue. (Inherited from IClassWithBaseClassReference)
	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
	AddAttributeTypeReference	Adds an AttributeType reference to this ObjectWithAttribute using the provided AttributeType object. The AttributeType reference is added as a AttributeType object. (Defined by ObjectWithAttributes)
	AddAttributeTypeReference	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)
	AddInterfaceClassReference	Adds an InterfaceClass reference to this ObjectWithExternalInterface using the provided InterfaceClass object. The InterfaceClass reference is added as a ExternalInterfaceType object. (Defined by ObjectWithExternalInterface)
	AddInterfaceClassReference	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)
	AMLAttributes	Conversion of any object which has an attribute collection to get access to specific AutomationML defined attributes. (Defined by AmlObjectsExtensions)
	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)
	Attributes	Enumeration Method for direct Children of Type AttributeType (Defined by AMLEngineAdapter)
	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)
	CopyAttributesFrom	Copies all attribute of the source object with attributes to the target object including children (Defined by ObjectWithAttributes)
	CreateListAttribute	Creates a new list attribute for an element which can have attributes. (Defined by ListAttribute)
	DeleteInheritedElement	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)
	DescendantsT	Finds the descendants of the provided CAEX object which are of the given type. (Defined by CAEXBasicObjectExtensions)
	ExternalInterfaces	Enumeration Method for direct Children of Type InterfaceClassType (Defined by AMLEngineAdapter)
	FindCaexObjectFromIdT	Finds the CAEX object with the specified id and the specified Type. (Defined by CAEXBasicObjectExtensions)
	findExternalInterface	Searches for an ExternalInterface in this InternalElement (Defined by AMLEngineAdapter)
	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)
	FrameAttribute	Gets a defined FrameAttribute from the Attribute collection of the IObjectWithAttributes. If no such attribute exists, null is returned. (Defined by AmlObjectsExtensions)
	GetAttribute	Gets the first attribute with the specified name from the attribute collection of the CAEX object. (Defined by ObjectWithAttributes)
	getAttributeField	Get the whole attribute field containing a collection of all attributes of this object. (Defined by AMLEngineAdapter)
	GetAttributeValue	Returns an attribute value of a given attribute name. (Defined by AMLEngineAdapter)
	GetDerivedAttributes	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)
	GetDerivedInterfaces	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)
	GetExternalInterfaces	Gets the external interfaces. (Defined by AMLEngineAdapter)
	GetFullNodePath	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)
	GetInheritedAttributes	Gets a collection of Attribute objects that are inherited from base classes. The own attributes are included in the enumeration. (Defined by ObjectWithBaseClass)
	GetInheritedAttributesAndDescendants	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)
	GetInheritedInterfaces	Gets a collection of ExternalInterface objects that are inherited from base classes. (Defined by ObjectWithBaseClass)
	GetInheritedInterfacesAndDescendants	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)
	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)
	HasInterfaceClassReference	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)
	HasInterfaceClassReference	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)
	InheritedElementsTInheritedElement	Gets a collection of objects of the defined InheritedElement-Type that are inherited from base classes. (Defined by ObjectWithBaseClass)
	Insert_Attribute	Inserts an Attribute object in the Attribute collection of the objectWithAttributes. (Defined by SystemUnitClassTypeExtensions)
	Insert_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)
	InterfaceClassReferences	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)
	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)
	IsInherited	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)
	IsOverridden	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)
	Library	Gets the Library which contains this CAEX object. (Defined by CAEXBasicObjectExtensions)
	New_Attribute	Appends a new Attribute object with the defined name to the specified CAEX object. (Defined by ObjectWithAttributes)
	New_Copyright	Adds an new Copyright node to this object if it doesn't exists. (Defined by CAEXBasicObjectExtensions)
	New_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)
	New_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)
	New_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)
	New_Version	Adds an new Version node to this object if it doesn't exists. (Defined by CAEXBasicObjectExtensions)
	OfInterfaceClass	Gets all ExternalInterface objects from the specified objectWithExternalInterface, which are derived from an InterfaceClass, identified with the given interfaceClassPath. (Defined by ExternalInterfaceTypeExtensions)
	OverriddenElement	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)
	ReferencedClassName	Name of the referenced Class without path information. (Defined by ObjectWithBaseClass)
	RefTypeAttribute	Gets the RefTypeAttributeTypefrom the objectWithAttributes if one exists. This Attribute is defined for a COLLADAInterface. (Defined by AmlObjectsExtensions)
	RefURIAttribute	Gets the RefURIAttributeType from the objectWithAttributes if one exists. (Defined by AmlObjectsExtensions)
	SetAttributeValue	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)
	SetAttributeValue	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)
	SetAttributeValue	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)
	SetAttributeValue	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)
	SetAttributeValue	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)
	SetAttributeValueT	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)
	SetDescription	This method sets a description. If no description exists, it is created. (Defined by CAEXObjectExtensions)

Top

Reference

Aml.Engine.CAEX Namespace

ICAEXWrapper