This repository has been archived by the owner on Jun 22, 2019. It is now read-only.
T_CAEX_ClassModel_ExternalInterfaceType
AutomationML edited this page Feb 23, 2017
·
2 revisions
Class ExternalInterfaceType.
System.Object
TypeBase
CAEX_ClassModel.CAEXBasicObject
CAEX_ClassModel.CAEXObject
CAEX_ClassModel.InterfaceClassType
CAEX_ClassModel.ExternalInterfaceType
Namespace: CAEX_ClassModel
Assembly: AMLEngine (in AMLEngine.dll) Version: 3.5
C#
public class ExternalInterfaceType : InterfaceClassType
C++
public ref class ExternalInterfaceType : public InterfaceClassType
The ExternalInterfaceType type exposes the following members.
Name | Description | |
---|---|---|
ExternalInterfaceType | Initializes a new instance of the InterfaceClassType class. |
Name | Description | |
---|---|---|
BaseClass | Gets or sets the base class for this instance. if another base class is set, the value is overwritten. (Inherited from InterfaceClassType.) | |
ClassName | Gets the name of the CAEXObject. (Inherited from InterfaceClassType.) | |
Copyright | Get the CopyrightType of this header object. (Inherited from CAEXBasicObject.) | |
Description | Get the description of this object. The returned object is null when no description element is found! (Inherited from CAEXBasicObject.) | |
FrameAttribute | Gets the Frame attribute (Inherited from InterfaceClassType.) | |
GetRefBaseClassPath | Gets the reference base class path. (Inherited from InterfaceClassType.) | |
IDValue | Gets the identifier value. (Inherited from InterfaceClassType.) | |
IsAttachmentInterface | Gets a value indicating whether this instance is an attachment interface. (Inherited from InterfaceClassType.) | |
IsCOLLADAInterface | Gets a value indicating whether this instance is a collada interface. (Inherited from InterfaceClassType.) | |
IsPLCOpenLogicInterface | Gets a value indicating whether this instance is PLC open logic interface. (Inherited from InterfaceClassType.) | |
IsPLCOpenVariableInterface | Gets a value indicating whether this instance is PLC open variable interface. (Inherited from InterfaceClassType.) | |
ReferencedClassName | Gets the name of the referenced base class. (Inherited from InterfaceClassType.) | |
ReferencedClassPath | Gets the full path of the referenced base class. (Inherited from InterfaceClassType.) | |
RefTypeAttribute | Gets the reference type attribute. (Inherited from InterfaceClassType.) | |
RefURIAttribute | Gets the ExternalReference Attribute defined for this object. (Inherited from InterfaceClassType.) | |
SetRefBaseClassPath | Sets the reference base class path. (Inherited from InterfaceClassType.) | |
StaticInfo | Gets the static information. | |
Version | Get the VersionType of this header object. (Inherited from CAEXBasicObject.) |
Name | Description | |
---|---|---|
CAEXPath | Get the path to this in the object tree. For all objects, it returns the XML full Node Path except for Interface instances, then it returns GUID:InterfaceName. (Inherited from CAEXBasicObject.) | |
Children(Type) | Gets all Children of this instance which are of the specified childrenType. This returns only the direct Children. (Inherited from CAEXBasicObject.) | |
Children(Type, Func(XmlNode, CAEXBasicObject)) | Gets all Children of this instance which are of the specified childrenType. This returns only the direct Children. (Inherited from CAEXBasicObject.) | |
Children(T)() | Gets all Children of this instance which are of Type T. This returns only the direct Children. (Inherited from CAEXBasicObject.) | |
Children(T)(Func(XmlNode, T)) | Gets all Children of this instance which are of Type T. This returns only the direct Children. (Inherited from CAEXBasicObject.) | |
clone | Create a clone of this object via reflection. The underlying XMLNode is normally cloned and a new instance of this class is created via Activator.CreateInstance with the cloned xml node. If an object of type InternalElement should be cloned, the method create_unique copy is called instead of using reflection to automatically get new GUIDs assigned. (Inherited from CAEXBasicObject.) | |
CloneNode(Boolean) | Clones the node. (Inherited from CAEXBasicObject.) | |
CloneNode(Boolean, Boolean) | Clones the node. (Inherited from CAEXBasicObject.) | |
ConsistencyCheck_ClassReference | Check if the given classPath is a valid path to an existent class in the AML file. (Inherited from CAEXBasicObject.) | |
CreateInterfaceFamilyClass | Create an InterfaceClass from this interface (e.g. ExternalInterface). An InterfaceClass is of type InterfaceFamilyType and may contain InterfaceFamilyTypes as child elements. (Inherited from InterfaceClassType.) | |
Descendants(Type) | Gets all Descendants of this instance which are of the specified descendantType. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.) | |
Descendants(Type, Func(XmlNode, CAEXBasicObject)) | Gets all Descendants of this instance which are of the specified descendantType. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.) | |
Descendants(T)() | Gets all Descendants of this instance which are of Type T. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.) | |
Descendants(T)(Func(XmlNode, T)) | Gets all Descendants of this instance which are of Type T. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.) | |
Equals | Determines, if the specified Object and the current Object are equal. (Inherited from CAEXBasicObject.) | |
findInternalElement | Resolve a reference to an InternalElement and return the referenced element if found. Use FindFastByID for speed optimizations. (Inherited from CAEXBasicObject.) | |
FirstAncestor(T) | Gets the first ancestor of the specified type for this CaexObject (Inherited from CAEXBasicObject.) | |
GetAttribute | Gets the attribute with the specified name. (Inherited from InterfaceClassType.) | |
getAttributeField | Getting this Attributes collection (Inherited from InterfaceClassType.) | |
GetDerivedAttributes | Only InterfaceFamilyType objects do have class references and may contain derived attributes (InterfaceFamilyType is derived from this class). For ExternalInterfaces the own attributes are returned, if includeOwn ist true [default]. (Inherited from InterfaceClassType.) | |
getFullNodePath | Getting the full path from document root to the specified XmlNode. As name of an XmlNode is the value of the contained attribute "name" taken. Hierarchies are separated via the path separator (slash '/'). The name of the document root element CAEXFile is not contained in the path. (Inherited from CAEXBasicObject.) | |
GetHashCode | Returns a hash code for this instance. (Inherited from CAEXBasicObject.) | |
getLastAttributeNode | **Obsolete. ** Gets the last attribute node. (Inherited from CAEXBasicObject.) | |
getLastHeaderNode | This methods returns the last XmlNode of this CAEX basic object according to the element order given by the CAEX schema. In this context "last" describes the element that is at the end of this header elements. (Inherited from CAEXBasicObject.) | |
GetParent | This method returns the parent CAEXBasicObject of the current CAEXBasicObject. (Inherited from CAEXBasicObject.) | |
getReferencedClass | Getting the XmlNode for a class path. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.) | |
getReferencedGUID | Parsing a string of form GUID:Interface and returning the GUID (Inherited from CAEXBasicObject.) | |
getReferencedInterfaceClass | Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.) | |
getReferencedInterfaceName | Getting the name of the referenced Interface. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.) | |
getReferencedRoleClass | Getting a referenced RoleClass. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.) | |
getReferencedSystemUnitClass | Getting a referenced SystemUnitClass. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.) | |
GetReferenceHierarchy(T) | Getting the reference hierarchy. hierarchy is build up as a queue. the most specialized class is first one in queue (Inherited from CAEXBasicObject.) | |
Insert_Attribute | Inserting an attribute element to this class (Inherited from InterfaceClassType.) | |
Insert_Element | Inserting an element generically to this object. (Inherited from InterfaceClassType.) | |
Insert_TypeBaseElement | Generic method to insert an element of type TypeBase in this object. This method could be declared as abstract, but then all inherited classes have to implement this method but not all inherited classes use this method. (Inherited from CAEXBasicObject.) | |
MergeContent | Merging the content of this interface class with the given interface class by copying all attributes. (Inherited from InterfaceClassType.) | |
New_AdditionalInformation | Adding a new AdditionalInformation node to this basic object. It is allowed to insert more than one AdditionalInformation node (Inherited from CAEXBasicObject.) | |
New_Attribute | A new attribute is added to this object (Inherited from InterfaceClassType.) | |
New_Copyright | Adding an new Copyright node to this object. If a Copyright node is already existent when calling this method an exception is thrown. (Inherited from CAEXBasicObject.) | |
New_Description | Creating a new description element. An exception is thrown when a description element is already present. (Inherited from CAEXBasicObject.) | |
New_Revision | Creating a new revision element. According to CAEX schema each revision element must contain at least the two sub elements "RevisionDate" and "AuthorName". They are created with this revision object. The sibling order according to the CAEX Schema is preserved in that way, that revision nodes are always inserted nodes of type VersionType (Inherited from CAEXBasicObject.) | |
New_Version | Creating a new version element. An exception is thrown when a version element is already present. The sibling order according to the CAEX Schema is preserved in that way, that version nodes are always inserted after nodes of type DescriptionType (Inherited from CAEXBasicObject.) | |
RemoveHeader | Removing all header elements from this basic object (Inherited from CAEXBasicObject.) | |
SetDescription | This method sets a description. If no description exists, it is created. (Inherited from CAEXObject.) | |
ToString | Returning the name attribute of this element as string representation of the object (Inherited from CAEXObject.) |
Name | Description | |
---|---|---|
AdditionalInformation | The additional information (Inherited from CAEXBasicObject.) | |
Attribute | The attribute (Inherited from InterfaceClassType.) | |
ChangeMode | The change mode (Inherited from CAEXBasicObject.) | |
ID | The identifier (Inherited from CAEXObject.) | |
Name | The name (Inherited from CAEXObject.) | |
RefBaseClassPath | The reference base class path (Inherited from InterfaceClassType.) | |
Revision | The revision (Inherited from CAEXBasicObject.) |
Name | Description | |
---|---|---|
AttributesEquals | Compare all Attributes of two Objects with Attributes (Defined by CaexObjectComparer.) | |
CaexEquals | Compare the CAEXPath of two CaexBasicObjects. (Defined by CaexObjectComparer.) | |
Clone_Save(T) | Clones a CAEX Object. (Defined by BasicExtensions.) | |
CopyAttributesFrom | copies all attribute and nested attributes of a given InterfaceClass to the calling InterfaceClass to another object (Defined by ExternalizationExtensions.) | |
CopyToClipboard | Copies the XML node's outer xml text to the clipboard. The Data format string is set to "CAEX". (Defined by AutomationMLClipboard.) | |
FindByID(String) | Overloaded. Searches an object starting from the given CAEXBasicObject that has the given ID, the expected type must be casted in the source code. This search bases on XPath and is slow. (Defined by NavigationExtensions.) |
|
FindByID(T)(String) | Overloaded. Searches an object starting from the given CAEXBasicObject that has the given ID, the expected type must be given in angle brackets. (Defined by NavigationExtensions.) |
|
FindByXPath(String) | Overloaded. Searches a CAEXBasicObject from the given xPath, you must cast the returned CAEXBasicObject into the type you expect. The search bases on XPath and is slow. For speed optimization, use FindFastByPath instead. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.) |
|
FindByXPath(T)(String) | Overloaded. Searches a CAEXBasicObject from the given xPath, the type must be given in angle brackets. The search bases on XPath and is slow. For speed optimization, use FindFastByPath instead. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.) |
|
FindFastByPath | Performs a document wide fast search and returns a CAEXObject given by its ID. It is fast due to hash table support. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.) | |
GetAllLibraryClasses | Get all library classes withing a given Library object or CAEX-Class Object (Defined by NavigationExtensions.) | |
GetAllParentInternalElements | Gets all parents in correct order from root parent element to obj excluding the element itself. (Defined by NavigationExtensions.) | |
GetAncestors(T) | Gets all Ancestors in the Hierarchy of the specified Caex-Object, which are of Type T (Defined by NavigationExtensions.) | |
GetChangeMode | Returns the change mode out of the given CAEXBasicObject. (Defined by BasicExtensions.) | |
GetClassLibrary(T) | Enables every CAEXBasicObject, to get its class Library. You must specify the type of the ClassLibrary-Type that you expect. (Defined by NavigationExtensions.) | |
GetClassName | Returns the class name of the given external interface. (Defined by BasicExtensions.) | |
GetFullClassName | Returns the full class name of the given external interface. (Defined by BasicExtensions.) | |
GetInternalElementsAndExternalInterfaces | Get all internal elements and interfaces of the given CAEXObject as flat list (Defined by NavigationExtensions.) | |
GetLibraryOfCaexObject | Gets the library of any caex object. (Defined by NavigationExtensions.) | |
GetMetaObjectInformation() | Overloaded. this methods returns the meta information out of an existing AutomationML file for an AutomationML Object (Defined by BasicExtensions.) |
|
GetMetaObjectInformation(String) | Overloaded. this methods returns the meta information out of an existing AutomationML file for an AutomationML Object and a specific Writer-ID (Defined by BasicExtensions.) |
|
GetParent() | Overloaded. Enables every CAEXBasicObject to get its parent object as a CAEX_ClassModel class. You must cast the result in your own code. (Defined by BasicExtensions.) |
|
GetParent(T)() | Overloaded. Enables every CAEXBasicObject to get its parent object as a CAEX_ClassModel class. You must specify the type of the CAEX_ClassModel type that you exspect. (Defined by NavigationExtensions.) |
|
GetParentNodeName | Returns the AML node name of the parent (Defined by NavigationExtensions.) | |
GetRefBaseClassPath | Get the RefBaseClassPath of the given external interface. (Defined by BasicExtensions.) | |
InterfaceEquals | Comparing Interfaces (Attributes and CAEXPath) (Defined by CaexObjectComparer.) | |
IsAutomationMLBaseInterface | Determines whether the specified interface class is derived from the AutomationMLBase interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsCOLLADAInterface | Determines whether the specified interface class is derived from the COLLADAInterface interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsCommunicationInterface | Determines whether the specified interface class is derived from the Communication interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsDerivedFormInterfaceClass | Determines whether the specified interface class has an inheritance relation from the interface class, uniquely identifyable by the given interface class path. The interface class path may contain an alias. (Defined by AutomationMLInterfaceClassLib.) | |
IsExternalDataConnector | Determines whether the specified interface class is derived from the ExternalDataConnector interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsInterlockingConnector | Determines whether the specified interface class is derived from the InterlockingConnector interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsOrderInterface | Determines whether the specified interface class is derived from the Order interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsPLCopenXMLInterface | Determines whether the specified interface class is derived from the PLCopenXMLInterface interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsPortConnector | Determines whether the specified interface class is derived from the PortConnector interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsPPRConnector | Determines whether the specified interface class is derived from the PPRConnector interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
IsSignalInterface | Determines whether the specified interface class is derived from the SignalInterface interface class. The method can resolve alias references anywhere in the inheritance hierarchy. (Defined by AutomationMLInterfaceClassLib.) | |
MakeAutomationMLBaseInterface | Makes the AutomationML base interface. (Defined by AutomationMLInterfaceClassLib.) | |
MakeCOLLADAInterface | Makes the collada interface. (Defined by AutomationMLInterfaceClassLib.) | |
MakeCommunicationInterface | Makes the communication interface. (Defined by AutomationMLInterfaceClassLib.) | |
MakeExternalDataConnector | Makes the external data connector. (Defined by AutomationMLInterfaceClassLib.) | |
MakeInterlockingConnector | Makes the interlocking connector. (Defined by AutomationMLInterfaceClassLib.) | |
MakeOrderInterface | Makes the order interface. (Defined by AutomationMLInterfaceClassLib.) | |
MakePLCopenXMLInterface | Makes the PLCopen XML interface. (Defined by AutomationMLInterfaceClassLib.) | |
MakePortConnector | Makes the port connector. (Defined by AutomationMLInterfaceClassLib.) | |
MakePPRConnector | Makes the PPR connector. (Defined by AutomationMLInterfaceClassLib.) | |
MakeSignalInterface | Makes the signal interface. (Defined by AutomationMLInterfaceClassLib.) | |
Name | Get the Name of the specified object. (Defined by BasicExtensions.) | |
New_Revision | Creates a new Revision object including dataTime and AuthorName (Defined by SpecificExtensions.) | |
OwnerDocument | returns a CAEXDocument of an XML node (Defined by NavigationExtensions.) | |
Remove | Deletes the object from the AML document. (Defined by BasicExtensions.) | |
RemoveSplitPoint | Remove a split point defined for this object. (Defined by ExternalizationExtensions.) | |
RemoveSubElements(T) | Removes all InternalElement and ExternalInterface Elements from a SystemUnit Class. (Defined by BasicExtensions.) | |
Replace(T) | Replaces a CaexObject by another CaexObject (Defined by BasicExtensions.) | |
SetChangeMode | Sets or removes the change mode of the given CAEXBasicObject. (Defined by BasicExtensions.) | |
SetMetaObjectInformation(MetaObjectInformation) | Overloaded. this method is a short version of the setMetaInformation for any caex object (Defined by BasicExtensions.) |
|
SetMetaObjectInformation(String, String, String) | Overloaded. this function sets the meta information to store tool specific object-IDs (Defined by BasicExtensions.) |
|
SetSplitPointIfPossible | Record a split point for this object. Returns true if succeeded. Only allowed for objects of type InstanceHierarchy, InternalElement, SystemUnitClassLib, InterfaceClassLib, RoleClassLib. Will be split off and written to file only by SaveSplitModelParts(). (Defined by ExternalizationExtensions.) |
AMLEngine Documentation
Send comments on this topic to [AutomationML office](mailto:office%40automationml.org?Subject=AMLEngine Documentation)- Introduction
- [Version History](Version history)
- [Version 3.5](Version 3.4)
- [Version 3.1](Version 3.0)
- [Version 2.1](Version 2.1)
- [Version 2.0](Version 2.0)
- [Getting Started](Getting started)
- Examples
- AMLEngine API
- AttributeType
- AttributeValueRequirementType
- CAEXBasicObject
- CAEXDocument
- CAEXFileType
- CAEXObject
- ChangeModeStates
- CopyrightType
- DescriptionType
- ExternalInterfaceType
- ExternalReferenceType
- InstanceHierarchyType
- InterfaceClassLibType
- InterfaceClassType
- InterfaceFamilyType
- InterfaceNameMappingType
- InternalElementType
- InternalLinkType
- MappingType
- NominalScaledTypeType
- ObjectWithAttributes
- OrdinalScaledTypeType
- RefSemanticType
- RevisionType
- RoleClassLibType
- RoleClassType
- RoleFamilyType
- RoleRequirementsType
- SupportedRoleClassType
- SystemUnitClassLibType
- SystemUnitClassType
- SystemUnitFamilyType
- UnknownTypeType
- VersionType
- IClassWithBaseClassReference
- IInstantiable
- IObjectWithAttributes
- IObjectWithExternalInterface
- IObjectWithRoleReference
- CAEXPathReferenceTable Class
- CAEXTable(T) Class
- CAEXTables Class
- ElementCollection(T) Class
- PathReferenceElement Class
- ReferenceElement Class
- RepairTypeEnum Enumeration
- UpdateActionEnum Enumeration
- UpdateEventArgs Class
- ValidationElement Class
- ValidationKey Class
- ValidationTypeEnum Enumeration
- CAEX_ClassModel.XmlExtension Namespace