Class VisProperties

This class stores the settings for a visualization.

Inheritance

System.Object

VisProperties

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: IMLD.MixedRealityAnalysis.Core

Assembly: Assembly-CSharp.dll

Syntax

public class VisProperties

Constructors

VisProperties(Guid, VisType, Int32)

Initializes a new instance of the VisProperties class.

Declaration

public VisProperties(Guid visId, VisType visType, int anchorId)

Parameters

Type	Name	Description
System.Guid	visId	The System.Guid of the visualization.
VisType	visType	The type of the visualization, match a VisType.
System.Int32	anchorId	The id of the of the visualization.

VisProperties(Guid, VisType, Int32, List<Int32>, List<Int32>, List<Int32>)

Initializes a new instance of the VisProperties class.

Declaration

public VisProperties(Guid visId, VisType visType, int anchorId, List<int> objectids, List<int> conditions, List<int> sessions)

Parameters

Type	Name	Description
System.Guid	visId	The System.Guid of the visualization.
VisType	visType	The type of the visualization, match a VisType.
System.Int32	anchorId	The id of the of the visualization.
System.Collections.Generic.List<System.Int32>	objectids	A System.Collections.Generic.List<T> representing the AnalysisObject ids of the visualization.
System.Collections.Generic.List<System.Int32>	conditions	A System.Collections.Generic.List<T> representing the study conditions of the visualization
System.Collections.Generic.List<System.Int32>	sessions	A System.Collections.Generic.List<T> representing the study sessions of the visualization

Properties

AnchorId

Gets or sets the anchor id of the visualization.

Declaration

public int AnchorId { get; set; }

Property Value

Type	Description
System.Int32

Conditions

Gets or sets the list of conditions of the visualization.

Declaration

public List<int> Conditions { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>

ObjectIds

Gets or sets the list of analysis objects of the visualization.

Declaration

public List<int> ObjectIds { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>

Sessions

Gets or sets the list of sessions of the visualization.

Declaration

public List<int> Sessions { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>

VisId

Gets or sets the id of the visualization.

Declaration

public Guid VisId { get; set; }

Property Value

Type	Description
System.Guid

VisType

Gets or sets the type of the visualization.

Declaration

public VisType VisType { get; set; }

Property Value

Type	Description
VisType

Methods

Get(String)

Gets the property with the specified name. If the property may not exist, use TryGet<T>(String, out T) instead.

Declaration

public object Get(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	The name of the property.

Returns

Type	Description
System.Object	The property if it exists.

Exceptions

Type	Condition
System.Collections.Generic.KeyNotFoundException	propertyName is not a valid key.

Set(String, Object)

Sets the property of the specified name.

Declaration

public void Set(string propertyName, object propertyValue)

Parameters

Type	Name	Description
System.String	propertyName	The name of the property.
System.Object	propertyValue	The value of the property.

TryGet(String, out Object)

Gets the property with the specified name and type.

Declaration

public bool TryGet(string propertyName, out object propertyValue)

Parameters

Type	Name	Description
System.String	propertyName	The name of the property.
System.Object	propertyValue	The value of the property if it was found; otherwise, null.

Returns

Type	Description
System.Boolean	true if the property is found, false otherwise.

TryGet<T>(String, out T)

Gets the property with the specified name and type.

Declaration

public bool TryGet<T>(string propertyName, out T propertyValue)

Parameters

Type	Name	Description
System.String	propertyName	The name of the property.
T	propertyValue	The value of the property if it was found; otherwise, teh default for T.

Returns

Type	Description
System.Boolean	true if the property is found, false otherwise.

Type Parameters

Name	Description
T	The type of the expected output.