DOFObjectID ClassOpenDOF Object Access Library
DOFObjectID is the common representation for all DOF object identifiers.
Inheritance Hierarchy

SystemObject
  org.opendof.core.oalDOFObjectID
    org.opendof.core.oalDOFObjectIDAuthentication
    org.opendof.core.oalDOFObjectIDDomain
    org.opendof.core.oalDOFObjectIDSource

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
[SerializableAttribute]
public class DOFObjectID : DOFValue, 
	IComparable<DOFObjectID>, DOFImmutable

The DOFObjectID type exposes the following members.

Constructors

  NameDescription
Protected methodDOFObjectID(BufferedPacket)
Create an object identifier instance from serial form.
Protected methodDOFObjectID(Int32, Byte, IDictionaryByte, DOFObjectIDAttribute)
Construct a new object identifier.
Top
Methods

  NameDescription
Public methodCompareTo
Compare against another DOFObjectID.
Public methodStatic membercreate(Byte)
Create an DOFObjectID from a byte[] of data.
Public methodStatic membercreate(String)
Constructs a DOFObjectID from a String in the standard string format defined by the OpenDOF Technical Committee.
Public methodStatic membercreate(Byte, Int32)
Create an DOFObjectID from a byte[] of data at an offset.
Public methodStatic membercreate(DOFObjectID, DOFObjectIDAttribute)
Create a DOFObjectID, with a variable number of attributes, using an object identifier and zero or more attributes.
Public methodStatic membercreate(DOFObjectID, IListDOFObjectIDAttribute)
Create a DOFObjectID with a list of attributes, using an object identifier and attributes.
Public methodStatic membercreate(Int32, Byte, DOFObjectIDAttribute)
Create a DOFObjectID given its class, byte data and optionally attributes.
Public methodStatic membercreate(Int32, Byte, IListDOFObjectIDAttribute)
Create a DOFObjectID given its class, byte data and attributes.
Public methodStatic membercreate(DOFMarshalContext, Object, DOFPacket)
Create a DOFObjectID from serial form.
Public methodEquals (Overrides ObjectEquals(Object).)
Public methodequalsIgnoreAttributes
Compare against another DOFObjectID.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodgetAttribute
Get the specified attribute.
Public methodgetAttributes
Get this identifier's list of attributes.
Public methodgetBase
Get this object identifier without any attributes.
Public methodgetBytes
Get the binary form of this DOFObjectID.
Public methodgetData
Get the data associated with the base ID (the ID without attributes).
Public methodgetDataString
Return a string format of the base (the ID without attributes) data of the object identifier.
Public methodgetDOFType
Public methodGetHashCode (Overrides ObjectGetHashCode.)
Public methodgetIDClass
Get the class of this DOFObjectID.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodhasAttribute
Check if this DOFObjectID has a specific attribute type.
Public methodhasAttributes
Check if this DOFObjectID has any attributes.
Public methodisBroadcast
Determine if this DOFObjectID is the broadcast oid without attributes.
Public methodisCompatibleWith
Public methodisMulticast
Determine if this DOFObjectID is a multicast oid (broadcast with the Group attribute).
Public methodisUnicast
Determine if this DOFObjectID is unicast, meaning it doesn't use CLASS_BROADCAST.
Public methodmarshal
Public methodmatchesAtLeast
Compare against another DOFObjectID.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodtoStandardString
Get the identifier in a standardized string format.
Public methodToString
Get the identifier in a standardized string format.
(Overrides ObjectToString.)
Top
Fields

  NameDescription
Public fieldStatic memberALL_OBJECTS
The broadcast (wildcard) object identifier.
Protected fieldattributeMap
The oid's attributes.
Public fieldStatic memberBROADCAST
The broadcast (wildcard) object identifier.
Public fieldStatic memberCLASS_AS
The Authentication Server (AS) assigned object identifier class.
Public fieldStatic memberCLASS_AWS_RESOURCE_ID
The AWS Resource ID object identifier class.
Public fieldStatic memberCLASS_BROADCAST
The Broadcast object identifier class.
Public fieldStatic memberCLASS_DOMAIN
Public fieldStatic memberCLASS_EMAIL
Public fieldStatic memberCLASS_EUI48
The EUI-48 object identifier class.
Public fieldStatic memberCLASS_EUI64
The EUI-64 object identifier class.
Public fieldStatic memberCLASS_GUID
The GUID object identifier class.
Public fieldStatic memberCLASS_HIDLC
The HiDLC object identifier class.
Public fieldStatic memberCLASS_IPV4
The IPv4 Address object identifier class.
Public fieldStatic memberCLASS_IPV6
The IPv6 Address object identifier class.
Public fieldStatic memberCLASS_LODLC
The LoDLC object identifier class.
Public fieldStatic memberCLASS_MAC
The Mac Address object identifier class.
Public fieldStatic memberCLASS_ODP
The OpenDOF Project assigned object identifier class.
Public fieldStatic memberCLASS_SMART_ENERGY_SYSTEM_SERIAL_NUMBER
The Smart Energy System Serial Number object identifier class.
Protected fielddata
The oid's data.
Public fieldStatic memberDOMAIN_BROADCAST
The broadcast domain object identifier.
Protected fieldhashCode_Renamed
The oid's hashCode.
Protected fieldidClass
The oid's class id.
Public fieldStatic memberTYPE
This is the default type for all object identifiers.
Top
Remarks

DOFObjectID is the common representation for all DOF object identifiers. The class is highly optimized to both use little memory and also to provide fast responses to queries.

This class is immutable, and so it does not require clone or copy constructors.

Constructing DOFObjectID:

DOFObjectID instances are constructed with the various create(byte[]) methods.

See Also

Reference