Methods_T_CAEX_ClassModel_MappingType

MappingType Methods

The MappingType type exposes the following members.

Methods

 

	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.)
	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.)
	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_AttributeNameMapping	Insert_s the attribute name mapping.
	Insert_Element	Inserting an element generically to this object.
	Insert_InterfaceNameMapping	Appends the interface name mapping.
	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.)
	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_AttributeNameMapping	Adding a new AttributeNameMapping to this MappingObject. An AttributeNameMapping allows the definition of the mapping between attribute names of corresponding RoleClasses and SystemUnitClasses.
	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_InterfaceNameMapping	Mapping of interface names of corresponding RoleClasses and SystemUnitClasses.
	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.)

  Back to Top

Extension Methods

 

	Name	Description
	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.)
	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.)
	GetLibraryOfCaexObject	Gets the library of any caex object. (Defined by NavigationExtensions.)
	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.)
	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.)
	SetChangeMode	Sets or removes the change mode of the given CAEXBasicObject. (Defined by BasicExtensions.)

  Back to Top

See Also

Reference

MappingType Class
CAEX_ClassModel Namespace