![]() | Ref |
The RefTypeAttributeType type exposes the following members.
Name | Description | |
---|---|---|
![]() | RefTypeAttributeType | Initializes a new instance of the RefTypeAttributeType class. |
Name | Description | |
---|---|---|
![]() | AdditionalInformation |
Gets the collection of AdditionalInformation values contained in this instance.
(Inherited from CAEXBasicObject) |
![]() | Attribute |
Gets a collection of Attributes contained in this instance.
(Inherited from AttributeTypeType) |
![]() | AttributeAndDescendants |
Gets the attributes and all nested attributes.
(Inherited from AttributeTypeType) |
![]() | AttributeDataType |
Gets and sets the AttributeDataType attribute of this Attribute object.
If the referenced attribute type does not base on an XML standard base type, the AttributeDataType may remain empty
or not present.
(Inherited from AttributeTypeType) |
![]() | AttributePath |
Returns the attribute path, which is equal to the attribute name for any attribute, which is not a nested attribute
or a concatenation
of attribute names separated by the attribute path delimiter for nested attributes.
(Inherited from AttributeType) |
![]() | AttributeTreeOwner |
Gets the owner of the Attribute Tree. This is the first ancestor, which is not an AttributeType object.
(Inherited from AttributeType) |
![]() | AttributeTypeDefiningAttribute |
Gets the Attribute datatype which is valid for values of all ValueAttributes of this element.
For this class, it is the instance itself.
(Inherited from AttributeTypeType) |
![]() | AttributeTypeReference |
Gets and sets the AttributeType of an Attribute object, defining a new instance to class relation, using the CAEX
attribute
RefAttributeType.
(Inherited from AttributeType) |
![]() | AttributeValue |
Gets and set the encoded/decoded attribute value according to the defined AttributeDataType.
If no AtttibuteDatatype is defined the type is set
according to the ClrToXmlType(Type) result.
(Inherited from AttributeTypeType) |
![]() | CAEXDocument |
Gets the CAEX document of this CAEX object. If the CAEX object has not been inserted
into a document or has been removed from the document, the value is null.
(Inherited from CAEXWrapper) |
![]() | CAEXParent |
Gets the CAEXParent of this instance if it exists.
(Inherited from CAEXWrapper) |
![]() | CAEXSequenceOfCAEXObject |
Gets the CAEXSequence containing this CAEX object
(Inherited from CAEXWrapper) |
![]() | ChangeMode |
Gets and sets the change mode for a CAEX element (Optional in CAEX).
(Inherited from CAEXBasicObject) |
![]() | Constraint |
Gets the collection of AttributeValueRequirement objects contained in this instance.
(Inherited from AttributeTypeType) |
![]() | Copyright |
Gets and sets the Copyright for this object.
(Inherited from CAEXBasicObject) |
![]() | CopyrightElement |
Gets the wrapper for the Copyright element.
(Inherited from CAEXBasicObject) |
![]() | DefaultAttributeValue |
Gets and set the encoded/decoded default attribute value according to the defined AttributeDataType.
(Inherited from AttributeTypeType) |
![]() | DefaultValue |
Gets and sets the DefaultValue element of this Attribute object. Use the
property DefaultAttributeValue, to get or set the type encoded
default value according to the Attribute Data Type.
(Inherited from AttributeTypeType) |
![]() | Description |
Gets and sets the Description for this object.
(Inherited from CAEXBasicObject) |
![]() | DescriptionElement |
Gets the wrapper for the Description element.
(Inherited from CAEXBasicObject) |
![]() | Document |
Gets the XDocument of the wrapped XML-Element
(Inherited from CAEXWrapper) |
![]() | Exists |
Determines if this is a wrapper around an existing XML-Element
(Inherited from CAEXWrapper) |
![]() | ID |
Gets and sets a unique identifier of the CAEX object (optional in CAEX). AutomationML requires IDs for some
Elements.
These IDs are automatically set when such elements are created.
(Inherited from CAEXObject) |
![]() | IsDeleted |
Determines, if this object is not contained in any document
(Inherited from CAEXWrapper) |
![]() | IsMaster |
Gets a value indicating whether this instance is a master attribute referenced by mirror attributes.
(Inherited from AttributeType) |
![]() | IsMirror |
Gets a value indicating whether this instance is a mirror of another Attribute object.
(Inherited from AttributeType) |
![]() | IsOverridden |
Determines, if this is an overridden Attribute
(Inherited from AttributeTypeType) |
![]() | IsRefTypeAttribute | Gets a value indicating whether this instance is a RefURI attribute. |
![]() | Item |
Gets the type-decoded value and sets the type-encoded value
for the value attribute with the defined name. The
allowed Names are ATTRIBUTE_VALUE_STRING and
ATTRIBUTE_DEFAULTVALUE_STRING.
(Inherited from AttributeTypeType) |
![]() | Master |
Gets the master Attribute object if this is a mirror and the master can be found in this CAEX document.
(Inherited from AttributeType) |
![]() | MasterID |
Gets the identifier of the master Attribute if this is a Mirror. The identifier contains the ID of the attribute
owner followed by the Attribute path.
(Inherited from AttributeType) |
![]() | MasterParentID |
Gets the ID of the master attributes parent instance, if this is a mirror Attribute object. If it is not a mirror,
null is returned.
(Inherited from AttributeType) |
![]() | Name |
Gets and sets the name of the CAEX object (required in CAEX).
(Inherited from CAEXObject) |
![]() | Node |
Gets the wrapped XML-Element
(Inherited from CAEXWrapper) |
![]() | Owner |
Gets the wrapped Xml-Element's parent
(Inherited from CAEXWrapper) |
![]() | RefAttributeType |
Gets and sets the RefAttributeType CAEX attribute of the Attribute object.
This property is used to create instance to class relations between Attributes (instances)
and AttributeType objects (classes).
(Inherited from AttributeTypeType) |
![]() | Reference |
Gets the referenced class
(Inherited from CaexObjectWithReferenceT) |
![]() | ReferenceAttributeName |
Gets the Name of the attribute of the wrapped Xml-Element, which is used to define the reference to the base class.
(Inherited from CaexObjectWithReferenceT) |
![]() | RefSemantic |
Gets the collection of RefSemantic objects contained in this instance
(Inherited from AttributeTypeType) |
![]() | Revision |
Gets the collection of Revision objects contained in this instance.
(Inherited from CAEXBasicObject) |
![]() | SourceObjectInformation |
Gets the collection of SourceObjectInformation objects contained in this instance.
(Inherited from CAEXBasicObject) |
![]() | TagName |
Gets the name of the CAEX tag for this CAEX object.
(Inherited from CAEXWrapper) |
![]() | Unit |
Gets and sets the Unit attribute for this Attribute object.
(Inherited from AttributeTypeType) |
![]() ![]() | Value |
Gets and sets the Value for this Attribute object.
The correct XML-String representation for the defined AttributeDataType
has to be ensured by the caller.
(Inherited from AttributeTypeType) |
![]() | ValueAttributes |
Gets all the CAEXValue objects for the defined value attributes of this instance. Recognized value attributes are
ATTRIBUTE_DEFAULTVALUE_STRING and ATTRIBUTE_VALUE_STRING.
(Inherited from AttributeTypeType) |
![]() | Version |
Gets and sets the Version for this object.
(Inherited from CAEXBasicObject) |
![]() | VersionElement |
Gets the wrapper for the Version element.
(Inherited from CAEXBasicObject) |
Name | Description | |
---|---|---|
![]() | AddChild |
Appends a new element of the same type as this instance as a child element
(Inherited from CaexObjectWithReferenceT) |
![]() | AddReference |
Adds a reference to the provided referenced class using the CAEXPath of the
referenced class as the reference attribute value.
(Inherited from CaexObjectWithReferenceT) |
![]() | AssignNewGuidAsID |
Assigns the new unique identifier as a new ID to this CAEX object.
(Inherited from CAEXObject) |
![]() | CAEXChild |
Gets the first child of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper) |
![]() | CAEXChildren |
Gets all children of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper) |
![]() | 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 CAEXObject) |
![]() | CAEXSequence |
Gets the CAEXSequence owned by this CAEX object, which contains the specified CAEX object.
(Inherited from AttributeTypeType) |
![]() | CanAddReference |
Determines if this CAEX object can reference the provided target CAEX object
using the reference attribute.
(Inherited from CaexObjectWithReferenceT) |
![]() | ContainerT |
Gets the CAEX Container for elements of type T, which is owned by this CAEX object
(Inherited from AttributeTypeType) |
![]() | Copy |
Creates a copy of this CAEX object, containing all child elements.
The created copy will have replaced unique IDs and updated references, if
the assignNewIDs is set to true (default).
When a CAEX class is copied, the nested classes that can exist for AttributeType,
RoleClass, SystemUnitClass, and InterfaceClass could be included in the created copy, if
the includeSubClasses is set to true.
(Inherited from CAEXObject) |
![]() ![]() | Create | Creates a new RefURIAttribute using the specified document. |
![]() | CreateAttributeType |
Creates an AttriuteType from this Attribute instance.
(Inherited from AttributeType) |
![]() | CreateMirror |
Creates a new mirror element from this AttributeType
(Inherited from AttributeType) |
![]() | Equals |
Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper) |
![]() | GetCaexValue |
Gets the CaexValue for the value attribute with the defined attribute name. The allowed Names as
ATTRIBUTE_VALUE_STRING and
ATTRIBUTE_DEFAULTVALUE_STRING.
(Inherited from AttributeTypeType) |
![]() | 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 AttributeTypeType) |
![]() | 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 fall back conversion, if the first
conversion
fails.
(Inherited from AttributeTypeType) |
![]() | GetHashCode |
Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper) |
![]() | GetXAttributeValue |
Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element.
(Inherited from CAEXWrapper) |
![]() | Import |
Imports the specified CAEX object in it's associated sequence. The provided
CAEX object is copied and all references are recalculated before it is
inserted.
(Inherited from AttributeTypeType) |
![]() | Insert(CAEXWrapper, Boolean) |
Inserts the specified CAEX object in it's associated sequence. The AttributeType
defines additional sequences for Attribute,
Constraint
and RefSemantic.
(Inherited from AttributeTypeType) |
![]() | Insert(Int32, CAEXWrapper) |
Inserts the specified CAEX object in it's associated sequence at the defined position. The AttributeType
defines additional sequences for Attribute,
Constraint
and RefSemantic.
(Inherited from AttributeTypeType) |
![]() | InsertAfter |
Inserts the provided CAEX object as a new sibling after this CAEX object.
(Inherited from AttributeTypeType) |
![]() | InsertBefore |
Inserts the provided CAEX object as a new sibling before this CAEX object.
(Inherited from AttributeTypeType) |
![]() | InsertNew |
This method can be used to create an XML node, if this CAEX wrapper was instantiated without an XML node.
This method can only be applied, if an Owner is defined. The new created CAEX object is
inserted as a new child of the owner.
(Inherited from CAEXWrapper) |
![]() | IsExplicit | Determines whether this is an 'explicit' RefType |
![]() | IsImplicit | Determines whether this is an 'implicit' RefType |
![]() | IsInherited |
Determines, if this is an inherited attribute from a base class.
(Inherited from AttributeTypeType) |
![]() | 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 CAEXBasicObject) |
![]() | RecreateAttributeInstance |
Replaces the content of this Attribute object with the specified attribute type.
This Attribute object is changed to an instance of the provided Attribute Type.
(Inherited from AttributeType) |
![]() | Remove |
Removes this element. After that it is no longer assigned to a document and has no owner anymore.
(Inherited from CAEXWrapper) |
![]() | SetAttributeDataType(Object) |
Sets the attribute data type to the type of the provided value
(Inherited from AttributeTypeType) |
![]() | SetAttributeDataType(Type) |
Sets the attribute data type to the provided clr type
(Inherited from AttributeTypeType) |
![]() | SetDateTime |
Sets the specified dateTime value as the attribute value. The AttributeDataType is set to xs:dateTime
(Inherited from AttributeTypeType) |
![]() | SetDouble |
Sets the specified double value as the attribute value. The AttributeDataType is set to xs:double
(Inherited from AttributeTypeType) |
![]() | SetXAttributeValue |
Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null).
(Inherited from CAEXWrapper) |
![]() | ToString |
Returns the value of the 'Name' attribute of this CAEX object as the 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 AttributeTypeType) |
![]() | TryGetDouble |
Tries to parse the Attribute Value string as double.
This method uses the XmlConvert ToDouble(String) method and a fall back conversion, if the first
conversion
fails.
(Inherited from AttributeTypeType) |
![]() | UpdateInstance |
Updates the Attribute using added attributes of the referenced Attribute Type.
(Inherited from AttributeType) |
Name | Description | |
---|---|---|
![]() | PropertyChanged |
The Change event raised when any property is modified.
(Inherited from CAEXWrapper) |
Name | Description | |
---|---|---|
![]() ![]() | REF_TYPE_ATTRIBUTE | The ref type attribute |
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
specified itemType is used as the attribute data type. If no itemType is defined, the default data type for
the list item is "xs:string". The Item name is automatically set to the Index if the List attribute is an ordered
list, otherwise the defined itemName is used.
(Defined by ListAttribute) |
![]() | AllLibraryReferences |
Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
![]() | AppendSignatureHeader |
This function appends a signature header to the provided CAEX object if it
does not exists. For an existing signature header the signature data is removed.
(Defined by CAEXSignatureHeader) |
![]() | AutomationMLEdition |
Gets the AutomationML edition of this caex object. The AutomationML edition is extracted
from the AutomationML filename, if it is coded in the name as defined in the library development
guide. If no edition is defined in the filename, the AutomationML version string is provided as
it is found in the AutomationML document.
(Defined by CAEXBasicObjectExtensions) |
![]() | clone | Copy(Boolean, Boolean, Boolean) (Defined by AMLEngineAdapter) |
![]() | CloneNode |
Clones the node.
(Defined by AMLEngineAdapter) |
![]() | ConsistencyCheck_ClassReference |
Check if the given classPath is a valid path to an existent class in the AML file.
(Defined by AMLEngineAdapter) |
![]() | 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) |
![]() | Copy |
Copies the CAEX object and assigns the name to the created copy.
(Defined by CAEXObjectExtensions) |
![]() | DeleteSignature |
This function deletes the existing Signatures from the caex Object
(Defined by CAEXSignatureHeader) |
![]() | Descendants |
Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions) |
![]() | Descendants |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
![]() | DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
![]() | findInternalElement |
Resolve a reference to an InternalElement and return the referenced element if found.
(Defined by AMLEngineAdapter) |
![]() | getReferencedClass |
Getting the XML Node for a class path.
(Defined by AMLEngineAdapter) |
![]() | getReferencedGUID |
Parsing a string of form GUID:Interface and returning the GUID
(Defined by AMLEngineAdapter) |
![]() | getReferencedInterfaceClass |
Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations.
(Defined by AMLEngineAdapter) |
![]() | getReferencedInterfaceName |
Getting the name of the referenced Interface.
(Defined by AMLEngineAdapter) |
![]() | GetSignatureHeader |
Get the Additional Information XML-Node from the CAEX object, which represents
the Signature node.
(Defined by CAEXSignatureHeader) |
![]() | HasNewVersion |
Determines, if this caex object has a related newer version
(Defined by CAEXBasicObjectExtensions) |
![]() | HasOldVersion |
Determines, if this caex object has a related older version
(Defined by CAEXBasicObjectExtensions) |
![]() | Insert_Element |
Inserting an element of base type TypeBase to this object. The Element is inserted at the first Element
of any existing Elements of the same Type if nothing else is explicit defined.
(Defined by AMLEngineAdapter) |
![]() | Insert_NewInstance |
Inserting a new class instance to this object. This method can be overridden in derived classes.
The Instance is inserted as the first instance of any other element with the same type if nothing
else is explicit defined.
(Defined by AMLEngineAdapter) |
![]() | Insert_TypeBaseElement | Insert(CAEXWrapper, Boolean) (Defined by AMLEngineAdapter) |
![]() | IsAssociatedExternalValue |
Determines whether the specified attribute reference defines an inheritance relation from the
AssociatedExternalValue AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsAssociatedFacet |
Determines whether the specified attribute reference defines an inheritance relation from the
AssociatedFacet AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsCardinality |
Determines whether the specified attribute reference defines an inheritance relation from the
Cardinality AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsCategory |
Determines whether the specified attribute reference defines an inheritance relation from the
Category AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsDerivedFromAttributeType |
Determines whether the specified attribute defines an inheritance relation from the attribute,
uniquely identifiable by the given attribute type path. The attribute type path may contain an alias.
(Defined by InheritanceExtensions) |
![]() | IsDirection |
Determines whether the specified attribute reference defines an inheritance relation from the
Direction AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsDocLang |
Determines whether the specified attribute reference defines an inheritance relation from the
DocLang AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsFacetAttribute |
Determines, if the attribute is an attribute of an AMLFacet.
(Defined by AmlObjectsExtensions) |
![]() | IsFrame |
Determines whether the specified attribute reference defines an inheritance relation from the
Frame AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsListAttribute |
Determines whether the specified attribute is a list attribute. This can be ordered or unordered.
(Defined by ListAttribute) |
![]() | IsListType |
Determines whether the specified attribute reference defines an inheritance relation from the
ListType AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsLocalizedAttribute |
Determines whether the specified attribute reference defines an inheritance relation from the
LocalizedAttribute AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsMaster |
Determines whether the specified Attribute is referenced by other Attribute
objects called 'Mirrors'.
(Defined by AttributeTypeTypeExtensions) |
![]() | IsMIMEType |
Determines whether the specified attribute reference defines an inheritance relation from the
MIMEType AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsOrderedListAttribute |
Determines whether the specified attribute is an ordered list attribute.
(Defined by ListAttribute) |
![]() | IsOrderedListType |
Determines whether the specified attribute reference defines an inheritance relation from the
OrderedListType AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsOverridden |
Determines whether this instance is overridden.
(Defined by AttributeTypeTypeExtensions) |
![]() | IsOverriddenDeleted |
Determines whether this instance is overridden and deleted.
(Defined by AttributeTypeTypeExtensions) |
![]() | IsRefTypeAttribute |
Gets a value indicating whether this instance is a RefType attribute.
(Defined by AmlObjectsExtensions) |
![]() | IsRefUri |
Determines whether the specified attribute reference defines an inheritance relation from the
RefURI AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
![]() | IsRefURIAttribute |
Gets a value indicating whether this instance is a RefURI attribute.
(Defined by AmlObjectsExtensions) |
![]() | IsUnOrderedListAttribute |
Determines whether the specified attribute is an unordered list attribute.
(Defined by ListAttribute) |
![]() | ListItems |
Gets the values of all items in the list attribute
(Defined by ListAttribute) |
![]() | ListItemValues |
Gets the values of all items in the 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 AMLEngineAdapter) |
![]() | Name |
Gets a names for the specified CAEX wrapper object. If the specified object is
a CAEXObject, the Name is returned; otherwise the TagName of the
CAEX item.
(Defined by CAEXBasicObjectExtensions) |
![]() | New_Description |
Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
![]() | New_RefSemantic |
Appends a new RefSemantic object with the defined semantics to the specified CAEX object.
(Defined by AttributeTypeTypeExtensions) |
![]() | ToRefTypeAttribute |
Converts an AttributeType to a RefTypeAttribute.
(Defined by AmlObjectsExtensions) |
![]() | ToRefURIAttribute |
Converts an AttributeType to a RefUriAttribute.
(Defined by AmlObjectsExtensions) |