 | Object |
The ObjectWithAMLAttributes type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | 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 instance, which contains the specified CAEX object.
For example, if the specified object is a revision object,
the sequence of the revision objects Revision is returned.
(Inherited from CAEXBasicObject) |
| ContainerT |
Gets the CAEX Container for elements of type T, which is owned by this CAEX object
(Inherited from CAEXBasicObject) |
| 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) |
| Equals |
Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper) |
| 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 CAEXBasicObject) |
| Insert(CAEXWrapper, Boolean) |
Inserts the specified CAEX object in it's associated sequence. The CAEXBasicObject
defines the Revision and SourceObjectInformation sequences.
(Inherited from CAEXBasicObject) |
| Insert(Int32, CAEXWrapper) |
Inserts the specified CAEX object in it's associated sequence at the defined position. The CAEXBasicObject
defines the Revision and SourceObjectInformation sequences.
(Inherited from CAEXBasicObject) |
| 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) |
| New_FrameAttribute | Creates a new Frame attribute for the CAEXBase if no Frame attribute exists. The provided values are used to initialize the Frame attribute values. |
| New_RefUriAttribute | Creates a new RefURI attribute for the CAEXBase object if none exists. The RefURI attribute value is set to the provided Uri. |
| 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 element. After that it is no longer assigned to a document and has no owner anymore.
(Inherited from CAEXWrapper) |
| 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) |
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) |
| 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) |
| 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) |
| CreateListAttribute |
Creates a new list attribute for an element which can have attributes.
(Defined by ListAttribute) |
| 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) |
| 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) |
| 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) |
| 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_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) |
| 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) |
See Also