cim1.model

Class RegulatingControl

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.RegulatingControl

public class RegulatingControl
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "RegulatingControl.java" represents the class RegulatingControl extends IdentifiedObject + TapChanger 0..-1 TapChanger (inverseAssociation) + discrete 1..1 boolean + RegulatingCondEq 0..-1 RegulatingCondEq (inverseAssociation) + targetRange 1..1 float + mode 1..1 RegulatingControlModeKind + targetValue 1..1 float + Terminal 1..1 Terminal

Field Summary

Fields

Modifier and Type	Field and Description
boolean	discrete Attribute "discrete" Comment from profile: The regulation is performed in a discrete mode.
java.lang.String	idTerminal The id of the attribute "terminal" This id is mainly used to resolve links after parsing an instance
RegulatingControlModeKind	mode Attribute "mode" Comment from profile: The regulating control mode presently available.
java.util.List<RegulatingCondEq>	regulatingCondEq Attribute "regulatingCondEq" Comment from profile: copy from reg cond eq
java.util.List<TapChanger>	tapChanger Attribute "tapChanger" Comment from profile: copy from reg conduting eq
float	targetRange Attribute "targetRange" Comment from profile: This is the case input target range.
float	targetValue Attribute "targetValue" Comment from profile: The target value specified for case input.
Terminal	terminal Attribute "terminal" Comment from profile: The terminal associated with this regulating control.

Fields inherited from class cim1.model.IdentifiedObject

aliasName, description, name

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegulatingControl() Constructor of the class RegulatingControl

Method Summary

Modifier and Type	Method and Description
void	addRegulatingCondEq(RegulatingCondEq regulatingCondEqValue, boolean setInverse) Utility to add a value within the "regulatingCondEq" ArrayList of "RegulatingCondEq"
void	addTapChanger(TapChanger tapChangerValue, boolean setInverse) Utility to add a value within the "tapChanger" ArrayList of "TapChanger"
protected void	clearAssociations(Subset subset) Utility to clear the associations of this class belonging to a specific subset
void	clearContent(Subset subset) Utility to "clear" the content of a class when a subset is invalidated
RegulatingControl	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(RegulatingControl otherRegulatingControl) Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy
static RegulatingControl	create(java.lang.String id) Factory of the class
boolean	discreteIsSet() Utility to test if the value of "discrete" has been set
RegulatingControlModeKind	getMode() Utility to return the "mode" enum
java.util.List<RegulatingCondEq>	getRegulatingCondEq() Utility to return the "regulatingCondEq" List of "RegulatingCondEq" enum
java.util.List<TapChanger>	getTapChanger() Utility to return the "tapChanger" List of "TapChanger" enum
float	getTargetRange() Utility to return the "targetRange" value
float	getTargetValue() Utility to return the "targetValue" value
Terminal	getTerminal() Utility to return the "terminal"
boolean	isDiscrete() Utility to return the "discrete" value
boolean	modeIsSet() Utility to test if the value of "mode" has been set
ConsistencyCheck	modelConsistency() Utility to check whether this class is consistent in a "merged" context
ConsistencyCheck	modelConsistency(Subset subset) Utility to check whether this class is consistent according to a subset
void	readAttribute(java.lang.String class_name, java.lang.String attr_name, java.lang.String value, CIMModel model) Utility to read an attribute This function is called by the CIMModel
void	readResource(java.lang.String class_name, java.lang.String resource_name, java.lang.String id, CIMModel model) Utility to read a reference to a resource This function is called by the CIMModel
boolean	regulatingCondEqIsSet() Utility to test if the value of "regulatingCondEq" has been set
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
void	setDiscrete(boolean discreteValue) Utility to set the "discrete" value
void	setMode(RegulatingControlModeKind modeValue) Utility to set the "mode" enum
void	setTargetRange(float targetRangeValue) Utility to set the "targetRange" value
void	setTargetValue(float targetValueValue) Utility to set the "targetValue" value
void	setTerminal(Terminal terminalValue, boolean setInverse) Utility to set the "terminalValue"
boolean	tapChangerIsSet() Utility to test if the value of "tapChanger" has been set
boolean	targetRangeIsSet() Utility to test if the value of "targetRange" has been set
boolean	targetValueIsSet() Utility to test if the value of "targetValue" has been set
boolean	terminalIsSet() Utility to test if the value of "terminal" has been set
void	write(javax.xml.stream.XMLStreamWriter xmlsw, boolean writeID) Utility to write the content into the CIM XML format
void	write(javax.xml.stream.XMLStreamWriter xmlsw, Subset subset, boolean writeID) Utility to write the content this class into the CIM/XML format according to a subset

Methods inherited from class cim1.model.IdentifiedObject

aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName

Methods inherited from class cim1.model.CIMInstance

addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tapChanger

public java.util.List<TapChanger> tapChanger

Attribute "tapChanger" Comment from profile: copy from reg conduting eq

discrete

public boolean discrete

Attribute "discrete" Comment from profile: The regulation is performed in a discrete mode.

regulatingCondEq

public java.util.List<RegulatingCondEq> regulatingCondEq

Attribute "regulatingCondEq" Comment from profile: copy from reg cond eq

targetRange

public float targetRange

Attribute "targetRange" Comment from profile: This is the case input target range. This performs the same function as the value2 attribute on the regulation schedule in the case that schedules are not used. The units of those appropriate for the mode.

mode

public RegulatingControlModeKind mode

Attribute "mode" Comment from profile: The regulating control mode presently available. This specifications allows for determining the kind of regualation without need for obtaining the units from a schedule.

targetValue

public float targetValue

Attribute "targetValue" Comment from profile: The target value specified for case input. This value can be used for the target value wihout the use of schedules. The value has the units appropriate to the mode attribute.

terminal

public Terminal terminal

Attribute "terminal" Comment from profile: The terminal associated with this regulating control.

idTerminal

public java.lang.String idTerminal

The id of the attribute "terminal" This id is mainly used to resolve links after parsing an instance

Constructor Detail

RegulatingControl

protected RegulatingControl()

Constructor of the class RegulatingControl

Method Detail

getTapChanger

public java.util.List<TapChanger> getTapChanger()

Utility to return the "tapChanger" List of "TapChanger" enum

Returns:

the list of the attributes "tapChanger"

addTapChanger

public void addTapChanger(TapChanger tapChangerValue,
                          boolean setInverse)
                   throws LinkageException

Utility to add a value within the "tapChanger" ArrayList of "TapChanger"

Parameters:

tapChangerValue - value to add within the ArrayList

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

tapChangerIsSet

public boolean tapChangerIsSet()

Utility to test if the value of "tapChanger" has been set

Returns:

boolean if true the attribute "tapChanger" is already set if false it isn't yet

isDiscrete

public boolean isDiscrete()

Utility to return the "discrete" value

Returns:

the value of the attribute "discrete"

setDiscrete

public void setDiscrete(boolean discreteValue)

Utility to set the "discrete" value

Parameters:

discreteValue - value to set

discreteIsSet

public boolean discreteIsSet()

Utility to test if the value of "discrete" has been set

Returns:

boolean if true the attribute "discrete" is already set if false isn't yet

getRegulatingCondEq

public java.util.List<RegulatingCondEq> getRegulatingCondEq()

Utility to return the "regulatingCondEq" List of "RegulatingCondEq" enum

Returns:

the list of the attributes "regulatingCondEq"

addRegulatingCondEq

public void addRegulatingCondEq(RegulatingCondEq regulatingCondEqValue,
                                boolean setInverse)
                         throws LinkageException

Utility to add a value within the "regulatingCondEq" ArrayList of "RegulatingCondEq"

Parameters:

regulatingCondEqValue - value to add within the ArrayList

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

regulatingCondEqIsSet

public boolean regulatingCondEqIsSet()

Utility to test if the value of "regulatingCondEq" has been set

Returns:

boolean if true the attribute "regulatingCondEq" is already set if false it isn't yet

getTargetRange

public float getTargetRange()

Utility to return the "targetRange" value

Returns:

the value of the attribute "targetRange"

setTargetRange

public void setTargetRange(float targetRangeValue)

Utility to set the "targetRange" value

Parameters:

targetRangeValue - value to set

targetRangeIsSet

public boolean targetRangeIsSet()

Utility to test if the value of "targetRange" has been set

Returns:

boolean if true the attribute "targetRange" is already set if false isn't yet

getMode

public RegulatingControlModeKind getMode()

Utility to return the "mode" enum

Returns:

the value of the attribute "mode"

setMode

public void setMode(RegulatingControlModeKind modeValue)

Utility to set the "mode" enum

Parameters:

modeValue - operand to set

modeIsSet

public boolean modeIsSet()

Utility to test if the value of "mode" has been set

Returns:

boolean if true the attribute "mode" is already set if false it isn't yet

getTargetValue

public float getTargetValue()

Utility to return the "targetValue" value

Returns:

the value of the attribute "targetValue"

setTargetValue

public void setTargetValue(float targetValueValue)

Utility to set the "targetValue" value

Parameters:

targetValueValue - value to set

targetValueIsSet

public boolean targetValueIsSet()

Utility to test if the value of "targetValue" has been set

Returns:

boolean if true the attribute "targetValue" is already set if false isn't yet

getTerminal

public Terminal getTerminal()

Utility to return the "terminal"

Returns:

the value of the attribute "terminal"

terminalIsSet

public boolean terminalIsSet()

Utility to test if the value of "terminal" has been set

Returns:

boolean if true the attribute "terminal" is already set if false it isn't yet

setTerminal

public void setTerminal(Terminal terminalValue,
                        boolean setInverse)
                 throws LinkageException

Utility to set the "terminalValue"

Parameters:

terminalValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

create

public static RegulatingControl create(java.lang.String id)

Factory of the class

Parameters:

id - id of the class RegulatingControl to create

Returns:

the class created

clearContent

public void clearContent(Subset subset)

Utility to "clear" the content of a class when a subset is invalidated

Overrides:

clearContent in class IdentifiedObject

Parameters:

subset - subset to clean

readAttribute

public void readAttribute(java.lang.String class_name,
                          java.lang.String attr_name,
                          java.lang.String value,
                          CIMModel model)
                   throws InterpretationException

Utility to read an attribute This function is called by the CIMModel

Overrides:

readAttribute in class IdentifiedObject

Parameters:

class_name - the read name of class

attr_name - the read name of attribute

value - the read value of the attribute

model - the interface to the model this class belongs to

Throws:

InterpretationException

readResource

public void readResource(java.lang.String class_name,
                         java.lang.String resource_name,
                         java.lang.String id,
                         CIMModel model)
                  throws InterpretationException,
                         LinkageException

Utility to read a reference to a resource This function is called by the CIMModel

Overrides:

readResource in class IdentifiedObject

Parameters:

class_name - the read name of class

resource_name - the read name of the associated resource

id - the id of the associated resource

model - the model this class belongs to

Throws:

InterpretationException

LinkageException

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  boolean writeID)

Utility to write the content into the CIM XML format

Overrides:

write in class IdentifiedObject

Parameters:

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - XMLStreamWriter where are stored the elements to write

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  Subset subset,
                  boolean writeID)

Utility to write the content this class into the CIM/XML format according to a subset

Overrides:

write in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to write this class

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - the stream in which are stored the elements to write

resolveLinks

public void resolveLinks(CIMModel model,
                         CIMModel boundaryModel)
                  throws LinkageException

Utility to resolve the links at the end of parsing

Overrides:

resolveLinks in class IdentifiedObject

Parameters:

model - the model this class belongs to

boundaryModel - the model that gather data about the boundarySet, used as a resource force links resolving

Throws:

Linkage - Exception

LinkageException

modelConsistency

public ConsistencyCheck modelConsistency(Subset subset)

Utility to check whether this class is consistent according to a subset

Overrides:

modelConsistency in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to check whether this class is consistent

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

modelConsistency

public ConsistencyCheck modelConsistency()

Utility to check whether this class is consistent in a "merged" context

Overrides:

modelConsistency in class IdentifiedObject

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

copyBase

public void copyBase(RegulatingControl otherRegulatingControl)

Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy

Parameters:

otherRegulatingControl - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

Utility to clear the associations of this class belonging to a specific subset

Overrides:

clearAssociations in class IdentifiedObject

Parameters:

subset - the subset from which to clear the associations of this class

clone

public RegulatingControl clone()

Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances

Overrides:

clone in class IdentifiedObject

Returns:

a clone of this instance