Methods_T_CAEX_ClassModel_RefURIAttributeType

RefURIAttributeType Methods

The RefURIAttributeType 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.)
	GetAttribute	Gets the attribute with the specified name. (Inherited from AttributeType.)
	getAttributeField	Get the whole attribute field containing a collection of all attributes of this object. (Inherited from AttributeType.)
	GetDateTime	Parse the Attribute Value string as dateTime. If the string can not be parsed, a format exception is returned. This method uses the XmlConvert ToDateTime(String, XmlDateTimeSerializationMode) method. (Inherited from AttributeType.)
	GetDerivedAttributes	An attribute type does not have any class references and therefore no derived attributes. If includeOwn is set to false, the returned list will always be the empty list. (Inherited from AttributeType.)
	GetDouble	Parse the Attribute Value string as double. If the string can not be parsed, a format exception is returned. This method uses the XmlConvert ToDouble(String) method and a fallback conversion, if the first conversion fails. (Inherited from AttributeType.)
	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.)
	GetTypedValue	Parse the Attribute Value string with the information, given in the AttributeDataType. If no Datatype is defined, the value string is returned. If a Datatype is defined, visit XML Datatypes for a description of type conversion behavior. As an example, for all DataTypes, which are converted to the .net String Type (xs:string, xs:normalizedString, etc..) whitespace replacement is performed, according to the restrictions defined by the AttributeDataType. For xs:ENTITIES, xs:IDREFS and xs:NMTOKENS the attribute value is converted to a whitespace-separated list of strings with the naming restricton of the base type. (Inherited from AttributeType.)
	Insert_Attribute	Appending an attribute element to this class (Inherited from AttributeType.)
	Insert_Element	Inserting an element generically to this object. (Inherited from AttributeType.)
	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.)
	IsAbsoluteUri	Determines whether [is absolute URI].
	IsFile	Determines whether this instance is file.
	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	Adding a new attribute child node to this attribute. (Inherited from AttributeType.)
	New_Constraint	Adding a Constraint node to this attribute. Use this method with caution. A constraint node has to be further specified by one of the three types: OrdinalScaledType, NominalScaledType or UnknownType. You can use the appropriate methods New_OrdinalScaledConstraint, New_NominalScaledConstraint or New_UnknownConstraint to add a constraint with the desired type in one step. If you forget to add a type to this constraint you will be no more conform to the schema! (Inherited from AttributeType.)
	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_DefaultValue	A new DefaultValue is added to this attribute. (Inherited from AttributeType.)
	New_Description	Creating a new description element. An exception is thrown when a description element is already present. (Inherited from CAEXBasicObject.)
	New_NominalScaledConstraint	A new nominal scaled constraint is added to this attribute. (Inherited from AttributeType.)
	New_OrdinalScaledConstraint	A new ordinal scaled constraint is added to this attribute. (Inherited from AttributeType.)
	New_RefSemantic	Adding a new RefSemantic node to this attribute. (Inherited from AttributeType.)
	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_UnknownConstraint	A new unknown constraint is added to this attribute. (Inherited from AttributeType.)
	New_Value	Add a new Value element to this attribute. (Inherited from AttributeType.)
	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.)
	SetDateTime	Sets the specified dateTime value as the attribute value. The AttributeDataType is set to xs:dateTime (Inherited from AttributeType.)
	SetDescription	This method sets a description. If no description exists, it is created. (Inherited from CAEXObject.)
	SetDouble	Sets the specified double value as the attribute value. The AttributeDataType is set to xs:double (Inherited from AttributeType.)
	ToString	Returning the name attribute of this element as string representation of the object (Inherited from CAEXObject.)
	TryGetDateTime	Tries to parse the Attribute Value string as dateTime. This method uses the XmlConvert ToDateTime(String, XmlDateTimeSerializationMode) method. (Inherited from AttributeType.)
	TryGetDouble	Tries to parse the Attribute Value string as double. This method uses the XmlConvert ToDouble(String) method and a fallback conversion, if the first conversion fails. (Inherited from AttributeType.)

  Back to Top

Extension Methods

 

	Name	Description
	AddListItem	Adds an additional list item attribute to the list attribute. If the List attribute already contains some items, the new item will have the same item type as the already existing items. If this is the first item, the sopecified itemType is used as the attribute data type. If no itemType is defined, the default datatype for the list item is "xs:string". The Item name is automatically set to the Index if the List attribute is an orderd list, otherwise the defined itemName is used. (Defined by ListAttribute.)
	AttributeEquals	Compare two Attribute Types (CAEXPath, AttributeDataType, AttributeUnit, AttributeValue, Nested Attributes) (Defined by CaexObjectComparer.)
	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.)
	ConvertToListAttribute	Changes the semantic of the specified attribute and converts to a list attribute. A first item is added to the List attribute which is initialized with valued from the converted attribute. If the Attribute is already a list attribute or the attribute contains child attributes it will not be converted. (Defined by ListAttribute.)
	CopyToClipboard	Copies the XML node's outer xml text to the clipboard. The Data format string is set to "CAEX". (Defined by AutomationMLClipboard.)
	Facet	If the attribute is an attribute of a facet, the facet internal element is returned; otherwise null is returned. (Defined by FacetType.)
	FacetAttributes	gets all facet attributes which can be related to the specified source attribute. if a relation is not defined, no elements are returned. (Defined by FacetType.)
	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.)
	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.)
	IsFacetAttribute	Determines, if the attribute is an attribute of a facet. (Defined by FacetType.)
	IsListAttribute	Determines whether the specified attribute is a list attribute. (Defined by ListAttribute.)
	IsOrderedListAttribute	Determines whether the specified attribute is an ordered list attribute (Defined by ListAttribute.)
	MakeListAttribute	Changes the semantic of the specified attribute and converts it to a list attribute. If the Attribute is already a list attribute or the attribute contains child attributes it will not be converted. (Defined by ListAttribute.)
	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.)
	SourceAttribute	If the specified attribute is defined in a facet, the corresponding source attribute is returned. If the specified attribute is a sub attribute of an attribute, defined in a facet, the corresponding sub attribute of the source attribute is returned. If the specified attribute is not contained in a facet null is returned. (Defined by FacetType.)
	Values	Gets the values of all items in the list attribute (Defined by ListAttribute.)

  Back to Top

See Also

Reference

RefURIAttributeType Class
CAEX_ClassModel Namespace