CAEXBasicObject Class

The class CAEXBasicObject comprises a basic set of attributes and header information which exist for all CAEX elements.

Inheritance Hierarchy

SystemObject
  Aml.Engine.CAEXCAEXWrapper
    Aml.Engine.CAEXCAEXBasicObject
      More

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

public class CAEXBasicObject : CAEXWrapper, 
	ICAEXContainer, ICAEXWrapper, IXMLWrapper, ICAEXBasicObject

Public Class CAEXBasicObject
	Inherits CAEXWrapper
	Implements ICAEXContainer, ICAEXWrapper, IXMLWrapper, ICAEXBasicObject

public ref class CAEXBasicObject : public CAEXWrapper, 
	ICAEXContainer, ICAEXWrapper, IXMLWrapper, ICAEXBasicObject

The CAEXBasicObject type exposes the following members.

Constructors

	Name	Description
	CAEXBasicObject	Initializes a new instance of the CAEXBasicObject class.

Top

Properties

	Name	Description
	AdditionalInformation	Gets the collection of AdditionalInformation values contained in this instance.
	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).
	Copyright	Gets and sets the Copyright for this object.
	CopyrightElement	Gets the wrapper for the Copyright element.
	Description	Gets and sets the Description for this object.
	DescriptionElement	Gets the wrapper for the Description element.
	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)
	IsDeleted	Determines, if this object is not contained in any document (Inherited from CAEXWrapper)
	Node	Gets the wrapped XML-Element (Inherited from CAEXWrapper)
	Owner	Gets the wrapped Xml-Element's parent (Inherited from CAEXWrapper)
	Revision	Gets the collection of Revision objects contained in this instance.
	SourceObjectInformation	Gets the collection of SourceObjectInformation objects contained in this instance.
	TagName	Gets the name of the CAEX tag for this CAEX object. (Inherited from CAEXWrapper)
	Version	Gets and sets the Version for this object.
	VersionElement	Gets the wrapper for the Version element.

Top

Methods

	Name	Description
	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)
	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.
	ContainerT	Gets the CAEX Container for elements of type T, which is owned by this CAEX object
	Copy	Creates a deep copy of this CAEX object (Inherited from CAEXWrapper)
	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.
	Insert(CAEXWrapper, Boolean)	Inserts the specified CAEX object in it's associated sequence. The CAEXBasicObject defines the Revision and SourceObjectInformation sequences.
	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.
	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.
	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)

Top

Events

	Name	Description
	PropertyChanged	The Change event raised when any property is modified. (Inherited from CAEXWrapper)

Top

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)
	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)
	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)
	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)

Top

Reference

Aml.Engine.CAEX Namespace

CAEXWrapper

Inheritance Hierarchy

SystemObject
  Aml.Engine.CAEXCAEXWrapper
    Aml.Engine.CAEXCAEXBasicObject
      Aml.Engine.CAEXAttributeValueRequirementType
      Aml.Engine.CAEXCAEXFileType
      Aml.Engine.CAEXCAEXObject
      Aml.Engine.CAEXExternalReferenceType
      Aml.Engine.CAEXMappingElementTypeT
      Aml.Engine.CAEXMappingType
      Aml.Engine.CAEXRefSemanticType
      Aml.Engine.CAEXRevisionType
      Aml.Engine.CAEXRoleRequirementsType
      Aml.Engine.CAEXSupportedRoleClassType