 | Attribute |
The AttributeFamilyType type exposes the following members.
Methods| 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.
(Overrides AttributeTypeTypeCAEXSequence(ICAEXWrapper)) |
| 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
(Overrides AttributeTypeTypeContainerT) |
| 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) |
| CreateClassInstance | Creates a class instance for this AttributeType object. All inherited base classes are resolved in the resulting Attribute. The Attribute collection of the new Attribute instance contains all inherited attributes from base classes."/> |
| 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) |
| GetEnumerator | Gets the Enumerator for the enumeration of the AttributeType field. |
| GetHashCode |
Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper) |
| GetReferenceHierarchy | Gets the reference (inheritance) hierarchy. The reference hierarchy includes this instance and the reference hierarchy of an associated BaseClass defining a class to class relation. |
| GetReferenceHierarchyT | Obsolete. Gets the reference (inheritance) hierarchy. The reference hierarchy includes this instance and the reference hierarchy of an associated BaseClass defining a class to class relation. |
| 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.
(Overrides AttributeTypeTypeImport(CAEXWrapper, String, Boolean)) |
| Insert(CAEXWrapper, Boolean) |
Inserts the specified CAEX object in it's associated sequence.
(Overrides AttributeTypeTypeInsert(CAEXWrapper, Boolean)) |
| Insert(Int32, CAEXWrapper) |
Inserts the specified CAEX object in it's associated sequence at the given position.
(Overrides AttributeTypeTypeInsert(Int32, CAEXWrapper)) |
| 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) |
| 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) |
| Remove |
Removes this AttributeType from the document.
(Overrides CAEXWrapperRemove(Boolean)) |
| 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) |
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) |
| AddChildWithReferenceAttributeFamilyType |
Appends a new element of the same type as a child element and
adds a reference from the child to this element.
(Defined by ObjectWithBaseClass) |
| AllLibraryReferences |
Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| 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) |
| 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) |
| Attributes |
Enumeration Method for direct Children of Type AttributeType (Defined by AMLEngineAdapter) |
| 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) |
| 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) |
| ChangeNameAndReferencesAttributeFamilyType |
Changes the name of the CAEX class and all the references to the class in the
whole CAEX document.
(Defined by InheritanceExtensions) |
| ClassIsDerivedFromAttributeFamilyType |
Determines, if the specified class is directly or indirectly (across multiple generations)
a descendant of the specified base class or identical to it. This method can be used, if the classes are
distributed over different CAEX documents, the documents should be referenced by external
references and alias references.
(Defined by InheritanceExtensions) |
| ClassIsDerivedFromAttributeFamilyType |
Determines, if the specified class is directly or indirectly (across multiple generations)
a descendant of the class or identical to it, which is uniquely identified with the specified baseClass path.
The base class path or the referenced class path may contain alias identifiers. If alias
identifiers are present, the method tries to load the external referenced document.
(Defined by InheritanceExtensions) |
| 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) |
| Copy |
Copies the CAEX object and assigns the name to the created copy.
(Defined by CAEXObjectExtensions) |
| CopyAttributesFrom |
Copies all attribute of the source object with attributes to the target object including
children
(Defined by ObjectWithAttributes) |
| CopyTreeAndChangeReferencesAttributeFamilyType |
Creates a copy of the source class and all its child classes and assigns the provided name to the copy.
Including references to objects in the original class tree are redirected to objects in the copied tree.
The copy is inserted into the provided parent object.
(Defined by InheritanceExtensions) |
| CreateClassInstanceAttributeType |
Creates a class instance of the CAEX class and assigns the name to the instance.
(Defined by InheritanceExtensions) |
| 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) |
| 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) |
| DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| FindCaexObjectFromIdT |
Finds the CAEX object with the specified id and the specified Type.
(Defined by CAEXBasicObjectExtensions) |
| findInternalElement |
Resolve a reference to an InternalElement and return the referenced element if found.
(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) |
| 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) |
| 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) |
| 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) |
| 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_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) |
| 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) |
| 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) |
| IsFrame |
Determines whether the specified attribute reference defines an inheritance relation from the
Frame AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
| 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) |
| 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) |
| IsMIMEType |
Determines whether the specified attribute reference defines an inheritance relation from the
MIMEType AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
| IsOrderedListType |
Determines whether the specified attribute reference defines an inheritance relation from the
OrderedListType AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
| 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) |
| IsRefUri |
Determines whether the specified attribute reference defines an inheritance relation from the
RefURI AttributeType
(Defined by AutomationMLBaseAttributeTypeLib) |
| Library |
Gets the Library which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| 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_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_Description |
Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
| 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_RefSemantic |
Appends a new RefSemantic object with the defined semantics to the specified CAEX object.
(Defined by AttributeTypeTypeExtensions) |
| New_Version |
Adds an new Version node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
| 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) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IEnumerableGetEnumerator | Gets the Enumerator for the enumeration of the AttributeType field. |
| IInstantiableCreateClassInstance | Creates a class instance for this AttributeType object. All inherited base classes are resolved in the resulting Attribute. |
See Also