Class DataPath

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Inheritance

object

DataPath

Namespace: IVLab.ABREngine

Assembly: IVLab.ABREngine.Runtime.dll

Syntax

public static class DataPath

Methods

| Improve this Doc View Source

FollowsConvention(string, DataPathType)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static bool FollowsConvention(string label, DataPath.DataPathType pathType = DataPathType.KeyData)

Parameters

Type	Name	Description
string	label
DataPath.DataPathType	pathType

Returns

Type	Description
bool

| Improve this Doc View Source

GetConvention(DataPathType)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetConvention(DataPath.DataPathType pathType)

Parameters

Type	Name	Description
DataPath.DataPathType	pathType

Returns

Type	Description
string

| Improve this Doc View Source

GetDataset(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetDataset(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetDatasetPath(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetDatasetPath(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetName(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetName(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetNamePath(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetNamePath(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetOrganization(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetOrganization(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetOrganizationPath(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetOrganizationPath(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetPathType(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetPathType(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

GetPathTypePath(string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string GetPathTypePath(string dataPath)

Parameters

Type	Name	Description
string	dataPath

Returns

Type	Description
string

| Improve this Doc View Source

Join(string, DataPathType)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string Join(string path1, DataPath.DataPathType pathType)

Parameters

Type	Name	Description
string	path1
DataPath.DataPathType	pathType

Returns

Type	Description
string

| Improve this Doc View Source

Join(string, DataPathType, string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string Join(string datasetPath, DataPath.DataPathType pathType3, string path4)

Parameters

Type	Name	Description
string	datasetPath
DataPath.DataPathType	pathType3
string	path4

Returns

Type	Description
string

| Improve this Doc View Source

Join(string, string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string Join(string path1, string path2)

Parameters

Type	Name	Description
string	path1
string	path2

Returns

Type	Description
string

| Improve this Doc View Source

Join(string, string, DataPathType, string)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static string Join(string path1, string path2, DataPath.DataPathType pathType3, string path4)

Parameters

Type	Name	Description
string	path1
string	path2
DataPath.DataPathType	pathType3
string	path4

Returns

Type	Description
string

| Improve this Doc View Source

WarnOnDataPathFormat(string, DataPathType)

A path to a data source, be it a KeyData object, a Scalar Variable, a Vector Variable, or something else.

Should take the form of Organization/DatasetName/*

Example: TACC/GulfOfMexico/KeyData/bathymetry

Example: TACC/GulfOfMexico/ScalarVar/temperature

Declaration

public static void WarnOnDataPathFormat(string dataPath, DataPath.DataPathType dataPathType)

Parameters

Type	Name	Description
string	dataPath
DataPath.DataPathType	dataPathType