Edit

location Class

  • Article

An abstraction of a physical location on hardware.

Syntax

class location;

Members

Public Constructors

Name Description
location Overloaded. Constructs a location object.
~location Destructor Destroys a location object.

Public Methods

Name Description
current Returns a location object representing the most specific place the calling thread is executing.
from_numa_node Returns a location object which represents a given NUMA node.

Public Operators

Name Description
operator!= Determines whether two location objects represent different location.
operator= Assigns the contents of a different location object to this one.
operator== Determines whether two location objects represent the same location.

Inheritance Hierarchy

location

Requirements

Header: concrt.h

Namespace: concurrency

~location

Destroys a location object.

~location();

current

Returns a location object representing the most specific place the calling thread is executing.

static location __cdecl current();

Return Value

A location representing the most specific place the calling thread is executing.

from_numa_node

Returns a location object which represents a given NUMA node.

static location __cdecl from_numa_node(unsigned short _NumaNodeNumber);

Parameters

_NumaNodeNumber
The NUMA node number to construct a location for.

Return Value

A location representing the NUMA node specified by the _NumaNodeNumber parameter.

location

Constructs a location object.

location();

location(
    const location& _Src);

location(
    T _LocationType,
    unsigned int _Id,
    unsigned int _BindingId = 0,
    _Inout_opt_ void* _PBinding = NULL);

Parameters

_Src

_LocationType

_Id

_BindingId

_PBinding
(Optional) Binding pointer.

Remarks

A default constructed location represents the system as a whole.

operator!=

Determines whether two location objects represent different location.

bool operator!= (const location& _Rhs) const;

Parameters

_Rhs
Operand location.

Return Value

true if the two locations are different, false otherwise.

operator=

Assigns the contents of a different location object to this one.

location& operator= (const location& _Rhs);

Parameters

_Rhs
The source location object.

Return Value

operator==

Determines whether two location objects represent the same location.

bool operator== (const location& _Rhs) const;

Parameters

_Rhs
Operand location.

Return Value

true if the two locations are identical, and false otherwise.

See also

concurrency Namespace