 | Caex |
Base class for all CAEX objects which may define a class to class relation referencing some base class.
Inheritance HierarchySystemObject
Aml.Engine.CAEXCAEXWrapper
Aml.Engine.CAEXCAEXBasicObject
Aml.Engine.CAEXCAEXObject
Aml.Engine.CAEXCaexObjectWithReferenceT
Aml.Engine.CAEXAttributeTypeType
Aml.Engine.CAEXInterfaceClassType
Aml.Engine.CAEXRoleClassType
Aml.Engine.CAEXSystemUnitClassType
Aml.Engine.CAEXCAEXWrapper
Aml.Engine.CAEXCAEXBasicObject
Aml.Engine.CAEXCAEXObject
Aml.Engine.CAEXCaexObjectWithReferenceT
Aml.Engine.CAEXAttributeTypeType
Aml.Engine.CAEXInterfaceClassType
Aml.Engine.CAEXRoleClassType
Aml.Engine.CAEXSystemUnitClassType
Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntaxpublic abstract class CaexObjectWithReference<T> : CAEXObject, IMultipleOccurrences<T>, ICAEXBasicObject, ICAEXWrapper, IXMLWrapper where T : CAEXObject
Type Parameters
- T
- Type parameter, specifying the CAEX class type.
The CaexObjectWithReferenceT type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AdditionalInformation |
Gets the collection of AdditionalInformation values contained in this instance.
(Inherited from CAEXBasicObject) |
| 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) |
| Copyright |
Gets and sets the Copyright for this object.
(Inherited from CAEXBasicObject) |
| CopyrightElement |
Gets the wrapper for the Copyright element.
(Inherited from CAEXBasicObject) |
| 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) |
| 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) |
| Reference | Gets the referenced class |
| ReferenceAttributeName | Gets the Name of the attribute of the wrapped Xml-Element, which is used to define the reference to the base class. |
| 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) |
| Version |
Gets and sets the Version for this object.
(Inherited from CAEXBasicObject) |
| VersionElement |
Gets the wrapper for the Version element.
(Inherited from CAEXBasicObject) |
Methods| Name | Description | |
|---|---|---|
 | AddChild | Appends a new element of the same type as this instance as a child element |
| AddReference | Adds a reference to the provided referenced class using the CAEXPath of the referenced class as the reference attribute value. |
| 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) |
| CanAddReference | Determines if this CAEX object can reference the provided target CAEX object using the reference attribute. |
| 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) |
| InsertAfter | Inserts the provided CAEX object as a new sibling after this CAEX object. |
| InsertBefore | Inserts the provided CAEX object as a new sibling before this CAEX object. |
| 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_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) |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged |
The Change event raised when any property is modified.
(Inherited from CAEXWrapper) |
Extension Methods| Name | Description | |
|---|---|---|
 | AllLibraryReferences |
Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| 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) |
| 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) |
| 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) |
| 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_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_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_Version |
Adds an new Version node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
See Also