Class Variable

Represents the logical description of a column of data.

Inheritance
Object
NotificationObject
IdentifiableBase
VersionableBase
DescribableBase
Variable
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class Variable : DescribableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IDescribable, IVisitable

Constructors

Variable()

Initializes a new instance of the Variable class.

Declaration
public Variable()

Properties

ActiveRepresentation

Gets the representation type.

Declaration
public ResponseDomain ActiveRepresentation { get; }
Property Value
Type Description
ResponseDomain

Additivity

Gets or sets the ability of the number to be meaningfully added.

Declaration
public AdditivityType Additivity { get; set; }
Property Value
Type Description
AdditivityType

AdditivityTypes

Gets an array of the supported additivity types.

Declaration
public static Array AdditivityTypes { get; }
Property Value
Type Description
Array

AggregationMethod

For aggregate variables, gets or sets the method used to tabulate other variables into this variable.

Declaration
public AggregationMethodType AggregationMethod { get; set; }
Property Value
Type Description
AggregationMethodType

AnalysisUnit

Gets or sets the entity to which the data refer, for example, individuals, families or households, groups, institutions or organizations, administrative units, etc.

Declaration
public string AnalysisUnit { get; set; }
Property Value
Type Description
String

CodeRepresentation

Gets or sets the code representation.

Declaration
public CodeDomain CodeRepresentation { get; set; }
Property Value
Type Description
CodeDomain

Concept

Gets or sets the concept measured by this variable.

Declaration
public Concept Concept { get; set; }
Property Value
Type Description
Concept

ConceptualVariable

Gets or sets the conceptual variable that represents the core of this variable, including the universe and concept of the variable.

Declaration
public ConceptualVariable ConceptualVariable { get; set; }
Property Value
Type Description
ConceptualVariable

DateTimeRepresentation

Gets or sets the date time representation.

Declaration
public DateTimeDomain DateTimeRepresentation { get; set; }
Property Value
Type Description
DateTimeDomain

Imputation

Gets or sets instructions that were used to calculate the values of data for this variable.

Declaration
public GeneralInstructionCoding Imputation { get; set; }
Property Value
Type Description
GeneralInstructionCoding

IsGeographic

Gets or sets if the variable is a geographic variable

Declaration
public bool IsGeographic { get; set; }
Property Value
Type Description
Boolean

IsTemporal

Gets or sets if the variable is a geographic variable

Declaration
public bool IsTemporal { get; set; }
Property Value
Type Description
Boolean

IsValid

Gets a value indicating whether the variable has a specified representation type.

Declaration
public bool IsValid { get; }
Property Value
Type Description
Boolean

IsWeight

Gets or sets if the Variable is a weight

Declaration
public bool IsWeight { get; set; }
Property Value
Type Description
Boolean

ItemType

Gets the universally unique identifier representing the item's type.

Declaration
public override Guid ItemType { get; }
Property Value
Type Description
Guid

The identifier representing the item's type.
Overrides

MeasurementUnit

Gets or sets the measurement unit of the data described by this variable.

Declaration
public string MeasurementUnit { get; set; }
Property Value
Type Description
String

MissingValues

Gets or sets a description of missing values for the variable.

Declaration
public ManagedMissingValuesRepresentation MissingValues { get; set; }
Property Value
Type Description
ManagedMissingValuesRepresentation
Remarks

For the missing value to be saved, the variable must have a representation set.

NumericRepresentation

Gets or sets the numeric representation.

Declaration
public NumericDomain NumericRepresentation { get; set; }
Property Value
Type Description
NumericDomain

RepresentationType

Gets or sets the type of the data described by the variable.

Declaration
public RepresentationType RepresentationType { get; set; }
Property Value
Type Description
RepresentationType

The type of the representation.

RepresentedVariable

Gets or sets the represented variable that represents the core of this variable, possibly including the universe, concept, and data type of the variable.

Declaration
public RepresentedVariable RepresentedVariable { get; set; }
Property Value
Type Description
RepresentedVariable

ResponseUnit

Gets or sets the who provided information contained by the variable (e.g., respondent, proxy, interviewer).

Declaration
public string ResponseUnit { get; set; }
Property Value
Type Description
String

Role

Gets or sets the specific function of the variable, such as identity, weight, geographic variable, etc.

Declaration
public string Role { get; set; }
Property Value
Type Description
String

SourceParameter

Gets or sets the source parameter from which data for this variable were gathered.

Declaration
public Parameter SourceParameter { get; set; }
Property Value
Type Description
Parameter

SourceQuestionBlocks

Gets any source question blocks that may have collected data described by this variable.

Declaration
public ObservableCollection<QuestionBlock> SourceQuestionBlocks { get; }
Property Value
Type Description
ObservableCollection<QuestionBlock>

SourceQuestionGrids

Gets any source question grids that may have collected data described by this variable.

Declaration
public ObservableCollection<QuestionGrid> SourceQuestionGrids { get; }
Property Value
Type Description
ObservableCollection<QuestionGrid>

SourceQuestions

Gets any source questions that may have collected data described by this variable.

Declaration
public ObservableCollection<Question> SourceQuestions { get; }
Property Value
Type Description
ObservableCollection<Question>

SourceVariables

Gets a collection of variables representing data from which data for this variable were computed.

Declaration
public ObservableCollection<Variable> SourceVariables { get; }
Property Value
Type Description
ObservableCollection<Variable>

StandardWeight

Gets or sets a standard weight that may be used in analyzing this variable.

Declaration
public StandardWeightCoding StandardWeight { get; set; }
Property Value
Type Description
StandardWeightCoding

TextRepresentation

Gets or sets the text representation.

Declaration
public TextDomain TextRepresentation { get; set; }
Property Value
Type Description
TextDomain

Universes

Gets the universes that describe the persons or other elements that this variable refers to, and to which any analytic results refer.

Declaration
public ObservableCollection<Universe> Universes { get; }
Property Value
Type Description
ObservableCollection<Universe>

WeightVariableReference

Gets or sets a weight variable that may be used in analyzing this variable.

Declaration
public Variable WeightVariableReference { get; set; }
Property Value
Type Description
Variable

Methods

GetChildren()

Gets the identifiers of the item's children.

Declaration
public override ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection

The identifiers of the item's children.
Overrides

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child

The child to be removed.
Returns
Type Description
Int32

The number of children removed from the item.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration
public override int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
Type Name Description
IdentifierTriple toReplace

The identifier of the child to replace.
IVersionable child

The new child.
Returns
Type Description
Int32

The number of children replaced.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

Implements

Extension Methods