Class: TLocalObjectName

Declaration: LocalObjectName.h

Taxonomy Categories:

Member Functions:

TLocalObjectName
operator=
~TLocalObjectName
operator<<=
operator>>=
operator==
Hash
GetType
GetInstance

Interface Category:

API.

Inherits From:

None.

Inherited By:

TNewServiceName

Purpose:

The name of a service. It contains a type and may contain an instance. The type identifies the general kind of service, such as a printer or a file system. The instance identifies the particular instance of the service, if more than one service of this type exists.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TLocalObjectName.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TLocalObjectName::TLocalObjectName

TLocalObjectName ()
TLocalObjectName (const TLocalObjectName &)
TLocalObjectName (const TLocalObjectType &)
TLocalObjectName (const TLocalObjectType &, const TLocalObjectInstance &)

Interface Category:

API.

Purpose:

Default constructor. The object created has a NIL type and an undefined instance.
Copy constructor.
Creates a TLocalObjectName with the specified type and an undefined instance.
Creates a TLocalObjectName with a the specified type and instance.

Calling Context:

Called by the stream-in operators and anywhere the definition of a TLocalObjectName is desired.
Called to copy a TLocalObjectName.
Called to create a TLocalObjectName with the specified instance field.
Called to create a TLocalObjectName with the specified type and instance fields.

Parameters:

Takes no parameters.
const TLocalObjectName & -The object to be copied.
const TLocalObjectType & -The type to use.
const TLocalObjectType & -The type to use.
const TLocalObjectInstance & -The instance to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::operator=

TLocalObjectName & operator =(const TLocalObjectName &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLocalObjectName & -The object to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::~TLocalObjectName

~ TLocalObjectName ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::operator<<=

TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Call this function directly.

Parameters:

TStream & -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::operator>>=

TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. Call this function directly.

Parameters:

TStream & -The stream to which the object streams itself.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::operator==

bool operator ==(const TLocalObjectName &) const

Interface Category:

API.

Purpose:

Returns true if the two TLocalObjectName objects on either side of the ==symbol have equal type and instance fields or if they have equal type fields and undefined instance fields.

Calling Context:

Called to test the equivalence of two objects. Call this function directly.

Parameters:

const TLocalObjectName & -The TLocalObjectName to compare to this object.

Return Value:

Returns true if both objects have equal type and instance fields or if they have equal type fields and undefined instance fields.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::Hash

long Hash () const

Interface Category:

API.

Purpose:

Returns a hash value for this TLocalObjectName.

Calling Context:

Called to obtain a hash value for this TLocalObjectName. Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A hash value for this TLocalObjectName.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Note that TLocalObjectName objects that have the same hash value are not necessarily equal.

Member Function: TLocalObjectName::GetType

void GetType (TLocalObjectType &) const

Interface Category:

API.

Purpose:

Fills in the argument with the type field from this object.

Calling Context:

Called to obtain the type field associated with this object. Call this function directly.

Parameters:

TLocalObjectType & -The argument to hold the type field.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalObjectName::GetInstance

bool GetInstance (TLocalObjectInstance &) const

Interface Category:

API.

Purpose:

Fills in the argument with the instance part of this object and returns true. If the instance is undefined, the argument remains unchanged and false is returned.

Calling Context:

Called to determine if there is an instance field associated with this object and to obtain it. Call this function directly.

Parameters:

TLocalObjectInstance & -The argument to hold the instance field.

Return Value:

Returns true if the instance field was defined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.