Represents an ObjectId (see also BsonObjectId). More...

Inheritance diagram for SequoiaDB.Bson.ObjectId:

Public Member Functions
	ObjectId (byte[] bytes)
	Initializes a new instance of the ObjectId class.

	ObjectId (DateTime timestamp, int machine, short pid, int increment)
	Initializes a new instance of the ObjectId class.

	ObjectId (int timestamp, int machine, short pid, int increment)
	Initializes a new instance of the ObjectId class.

	ObjectId (string value)
	Initializes a new instance of the ObjectId class.

int	CompareTo (ObjectId other)
	Compares this ObjectId to another ObjectId.

bool	Equals (ObjectId rhs)
	Compares this ObjectId to another ObjectId.

override bool	Equals (object obj)
	Compares this ObjectId to another object.

override int	GetHashCode ()
	Gets the hash code.

byte[]	ToByteArray ()
	Converts the ObjectId to a byte array.

override string	ToString ()
	Returns a string representation of the value.

TypeCode IConvertible.	GetTypeCode ()

bool IConvertible.	ToBoolean (IFormatProvider provider)

byte IConvertible.	ToByte (IFormatProvider provider)

char IConvertible.	ToChar (IFormatProvider provider)

DateTime IConvertible.	ToDateTime (IFormatProvider provider)

decimal IConvertible.	ToDecimal (IFormatProvider provider)

double IConvertible.	ToDouble (IFormatProvider provider)

short IConvertible.	ToInt16 (IFormatProvider provider)

int IConvertible.	ToInt32 (IFormatProvider provider)

long IConvertible.	ToInt64 (IFormatProvider provider)

sbyte IConvertible.	ToSByte (IFormatProvider provider)

float IConvertible.	ToSingle (IFormatProvider provider)

string IConvertible.	ToString (IFormatProvider provider)

object IConvertible.	ToType (Type conversionType, IFormatProvider provider)

ushort IConvertible.	ToUInt16 (IFormatProvider provider)

uint IConvertible.	ToUInt32 (IFormatProvider provider)

ulong IConvertible.	ToUInt64 (IFormatProvider provider)

Static Public Member Functions
static bool	operator< (ObjectId lhs, ObjectId rhs)
	Compares two ObjectIds.

static bool	operator<= (ObjectId lhs, ObjectId rhs)
	Compares two ObjectIds.

static bool	operator== (ObjectId lhs, ObjectId rhs)
	Compares two ObjectIds.

static bool	operator!= (ObjectId lhs, ObjectId rhs)
	Compares two ObjectIds.

static bool	operator>= (ObjectId lhs, ObjectId rhs)
	Compares two ObjectIds.

static bool	operator> (ObjectId lhs, ObjectId rhs)
	Compares two ObjectIds.

static ObjectId	GenerateNewId ()
	Generates a new ObjectId with a unique value.

static ObjectId	GenerateNewId (DateTime timestamp)
	Generates a new ObjectId with a unique value (with the timestamp component based on a given DateTime).

static ObjectId	GenerateNewId (int timestamp)
	Generates a new ObjectId with a unique value (with the given timestamp).

static byte[]	Pack (int timestamp, int machine, short pid, int increment)
	Packs the components of an ObjectId into a byte array.

static ObjectId	Parse (string s)
	Parses a string and creates a new ObjectId.

static bool	TryParse (string s, out ObjectId objectId)
	Tries to parse a string and create a new ObjectId.

static void	Unpack (byte[] bytes, out int timestamp, out int machine, out short pid, out int increment)
	Unpacks a byte array into the components of an ObjectId.

Properties
static ObjectId	Empty `[get]`
	Gets an instance of ObjectId where the value is empty.

int	Timestamp `[get]`
	Gets the timestamp.

int	Machine `[get]`
	Gets the machine.

short	Pid `[get]`
	Gets the PID.

int	Increment `[get]`
	Gets the increment.

DateTime	CreationTime `[get]`
	Gets the creation time (derived from the timestamp).

Detailed Description

Represents an ObjectId (see also BsonObjectId).

Constructor & Destructor Documentation

SequoiaDB.Bson.ObjectId.ObjectId ( byte[] bytes )

inline

Initializes a new instance of the ObjectId class.

Parameters

bytes The bytes.

SequoiaDB.Bson.ObjectId.ObjectId	(	DateTime	timestamp,
		int	machine,
		short	pid,
		int	increment
	)

inline

Initializes a new instance of the ObjectId class.

Parameters

timestamp	The timestamp (expressed as a DateTime).
machine	The machine hash.
pid	The PID.
increment	The increment.

SequoiaDB.Bson.ObjectId.ObjectId	(	int	timestamp,
		int	machine,
		short	pid,
		int	increment
	)

inline

Initializes a new instance of the ObjectId class.

Parameters

timestamp	The timestamp.
machine	The machine hash.
pid	The PID.
increment	The increment.

SequoiaDB.Bson.ObjectId.ObjectId ( string value )

inline

Initializes a new instance of the ObjectId class.

Parameters

value The value.

Member Function Documentation

int SequoiaDB.Bson.ObjectId.CompareTo ( ObjectId other )

inline

Compares this ObjectId to another ObjectId.

Parameters

other The other ObjectId.

Returns: A 32-bit signed integer that indicates whether this ObjectId is less than, equal to, or greather than the other.

bool SequoiaDB.Bson.ObjectId.Equals ( ObjectId rhs )

inline

Compares this ObjectId to another ObjectId.

Parameters

rhs	The other ObjectId.

Returns: True if the two ObjectIds are equal.

override bool SequoiaDB.Bson.ObjectId.Equals ( object obj )

inline

Compares this ObjectId to another object.

Parameters

obj	The other object.

Returns: True if the other object is an ObjectId and equal to this one.

static ObjectId SequoiaDB.Bson.ObjectId.GenerateNewId ( )

inlinestatic

Generates a new ObjectId with a unique value.

Returns: An ObjectId.

static ObjectId SequoiaDB.Bson.ObjectId.GenerateNewId ( DateTime timestamp )

inlinestatic

Generates a new ObjectId with a unique value (with the timestamp component based on a given DateTime).

Parameters

timestamp The timestamp component (expressed as a DateTime).

Returns: An ObjectId.

static ObjectId SequoiaDB.Bson.ObjectId.GenerateNewId ( int timestamp )

inlinestatic

Generates a new ObjectId with a unique value (with the given timestamp).

Parameters

timestamp The timestamp component.

Returns: An ObjectId.

override int SequoiaDB.Bson.ObjectId.GetHashCode ( )

inline

Gets the hash code.

Returns: The hash code.

static bool SequoiaDB.Bson.ObjectId.operator!=	(	ObjectId	lhs,
		ObjectId	rhs
	)

inlinestatic

Compares two ObjectIds.

Parameters

lhs	The first ObjectId.
rhs	The other ObjectId.

Returns: True if the two ObjectIds are not equal.

static bool SequoiaDB.Bson.ObjectId.operator<	(	ObjectId	lhs,
		ObjectId	rhs
	)

inlinestatic

Compares two ObjectIds.

Parameters

lhs	The first ObjectId.
rhs	The other ObjectId

Returns: True if the first ObjectId is less than the second ObjectId.

static bool SequoiaDB.Bson.ObjectId.operator<=	(	ObjectId	lhs,
		ObjectId	rhs
	)

inlinestatic

Compares two ObjectIds.

Parameters

lhs	The first ObjectId.
rhs	The other ObjectId

Returns: True if the first ObjectId is less than or equal to the second ObjectId.

static bool SequoiaDB.Bson.ObjectId.operator==	(	ObjectId	lhs,
		ObjectId	rhs
	)

inlinestatic

Compares two ObjectIds.

Parameters

lhs	The first ObjectId.
rhs	The other ObjectId.

Returns: True if the two ObjectIds are equal.

static bool SequoiaDB.Bson.ObjectId.operator>	(	ObjectId	lhs,
		ObjectId	rhs
	)

inlinestatic

Compares two ObjectIds.

Parameters

lhs	The first ObjectId.
rhs	The other ObjectId

Returns: True if the first ObjectId is greather than the second ObjectId.

static bool SequoiaDB.Bson.ObjectId.operator>=	(	ObjectId	lhs,
		ObjectId	rhs
	)

inlinestatic

Compares two ObjectIds.

Parameters

lhs	The first ObjectId.
rhs	The other ObjectId

Returns: True if the first ObjectId is greather than or equal to the second ObjectId.

static byte [] SequoiaDB.Bson.ObjectId.Pack	(	int	timestamp,
		int	machine,
		short	pid,
		int	increment
	)

inlinestatic

Packs the components of an ObjectId into a byte array.

Parameters

timestamp	The timestamp.
machine	The machine hash.
pid	The PID.
increment	The increment.

Returns: A byte array.

static ObjectId SequoiaDB.Bson.ObjectId.Parse ( string s )

inlinestatic

Parses a string and creates a new ObjectId.

Parameters

s	The string value.

Returns: A ObjectId.

byte [] SequoiaDB.Bson.ObjectId.ToByteArray ( )

inline

Converts the ObjectId to a byte array.

Returns: A byte array.

override string SequoiaDB.Bson.ObjectId.ToString ( )

inline

Returns a string representation of the value.

Returns: A string representation of the value.

static bool SequoiaDB.Bson.ObjectId.TryParse	(	string	s,
		out ObjectId	objectId
	)

inlinestatic

Tries to parse a string and create a new ObjectId.

Parameters

s	The string value.
objectId	The new ObjectId.

Returns: True if the string was parsed successfully.

static void SequoiaDB.Bson.ObjectId.Unpack	(	byte[]	bytes,
		out int	timestamp,
		out int	machine,
		out short	pid,
		out int	increment
	)

inlinestatic

Unpacks a byte array into the components of an ObjectId.

Parameters

bytes	A byte array.
timestamp	The timestamp.
machine	The machine hash.
pid	The PID.
increment	The increment.

Property Documentation

DateTime SequoiaDB.Bson.ObjectId.CreationTime

get

Gets the creation time (derived from the timestamp).

ObjectId SequoiaDB.Bson.ObjectId.Empty

staticget

Gets an instance of ObjectId where the value is empty.

int SequoiaDB.Bson.ObjectId.Increment

get

Gets the increment.

int SequoiaDB.Bson.ObjectId.Machine

get

Gets the machine.

short SequoiaDB.Bson.ObjectId.Pid

get

Gets the PID.

int SequoiaDB.Bson.ObjectId.Timestamp

get

Gets the timestamp.

The documentation for this struct was generated from the following file:

ObjectId.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation