cim1.model

Class LoadResponseCharacteristic

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.LoadResponseCharacteristic

public class LoadResponseCharacteristic
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "LoadResponseCharacteristic.java" represents the class LoadResponseCharacteristic extends IdentifiedObject + pVoltageExponent 0..1 float + EnergyConsumer 0..-1 EnergyConsumer (inverseAssociation) + qConstantPower 0..1 float + qConstantImpedance 0..1 float + exponentModel 1..1 boolean + pConstantImpedance 0..1 float + qVoltageExponent 0..1 float + qConstantCurrent 0..1 float + pConstantPower 0..1 float + pConstantCurrent 0..1 float

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<EnergyConsumer>	energyConsumer Attribute "energyConsumer" Comment from profile: The set of loads that have the response characteristics.
boolean	exponentModel Attribute "exponentModel" Comment from profile: Indicates the exponential voltage dependency model (pVoltateExponent and qVoltageExponent) is to be used.
float	pConstantCurrent Attribute "pConstantCurrent" Comment from profile: Portion of active power load modeled as constant current.
float	pConstantImpedance Attribute "pConstantImpedance" Comment from profile: Portion of active power load modeled as constant impedance.
float	pConstantPower Attribute "pConstantPower" Comment from profile: Portion of active power load modeled as constant power.
float	pVoltageExponent Attribute "pVoltageExponent" Comment from profile: Exponent of per unit voltage effecting real power.
float	qConstantCurrent Attribute "qConstantCurrent" Comment from profile: Portion of reactive power load modeled as constant current.
float	qConstantImpedance Attribute "qConstantImpedance" Comment from profile: Portion of reactive power load modeled as constant impedance.
float	qConstantPower Attribute "qConstantPower" Comment from profile: Portion of reactive power load modeled as constant power.
float	qVoltageExponent Attribute "qVoltageExponent" Comment from profile: Exponent of per unit voltage effecting reactive power.

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	LoadResponseCharacteristic() Constructor of the class LoadResponseCharacteristic

Method Summary

Modifier and Type	Method and Description
void	addEnergyConsumer(EnergyConsumer energyConsumerValue, boolean setInverse) Utility to add a value within the "energyConsumer" ArrayList of "EnergyConsumer"
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
LoadResponseCharacteristic	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(LoadResponseCharacteristic otherLoadResponseCharacteristic) 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 LoadResponseCharacteristic	create(java.lang.String id) Factory of the class
boolean	energyConsumerIsSet() Utility to test if the value of "energyConsumer" has been set
boolean	exponentModelIsSet() Utility to test if the value of "exponentModel" has been set
java.util.List<EnergyConsumer>	getEnergyConsumer() Utility to return the "energyConsumer" List of "EnergyConsumer" enum
float	getPConstantCurrent() Utility to return the "pConstantCurrent" value
float	getPConstantImpedance() Utility to return the "pConstantImpedance" value
float	getPConstantPower() Utility to return the "pConstantPower" value
float	getPVoltageExponent() Utility to return the "pVoltageExponent" value
float	getQConstantCurrent() Utility to return the "qConstantCurrent" value
float	getQConstantImpedance() Utility to return the "qConstantImpedance" value
float	getQConstantPower() Utility to return the "qConstantPower" value
float	getQVoltageExponent() Utility to return the "qVoltageExponent" value
boolean	isExponentModel() Utility to return the "exponentModel" value
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
boolean	pConstantCurrentIsSet() Utility to test if the value of "pConstantCurrent" has been set
boolean	pConstantImpedanceIsSet() Utility to test if the value of "pConstantImpedance" has been set
boolean	pConstantPowerIsSet() Utility to test if the value of "pConstantPower" has been set
boolean	pVoltageExponentIsSet() Utility to test if the value of "pVoltageExponent" has been set
boolean	qConstantCurrentIsSet() Utility to test if the value of "qConstantCurrent" has been set
boolean	qConstantImpedanceIsSet() Utility to test if the value of "qConstantImpedance" has been set
boolean	qConstantPowerIsSet() Utility to test if the value of "qConstantPower" has been set
boolean	qVoltageExponentIsSet() Utility to test if the value of "qVoltageExponent" has been set
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
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
void	setExponentModel(boolean exponentModelValue) Utility to set the "exponentModel" value
void	setPConstantCurrent(float pConstantCurrentValue) Utility to set the "pConstantCurrent" value
void	setPConstantImpedance(float pConstantImpedanceValue) Utility to set the "pConstantImpedance" value
void	setPConstantPower(float pConstantPowerValue) Utility to set the "pConstantPower" value
void	setPVoltageExponent(float pVoltageExponentValue) Utility to set the "pVoltageExponent" value
void	setQConstantCurrent(float qConstantCurrentValue) Utility to set the "qConstantCurrent" value
void	setQConstantImpedance(float qConstantImpedanceValue) Utility to set the "qConstantImpedance" value
void	setQConstantPower(float qConstantPowerValue) Utility to set the "qConstantPower" value
void	setQVoltageExponent(float qVoltageExponentValue) Utility to set the "qVoltageExponent" value
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

pVoltageExponent

public float pVoltageExponent

Attribute "pVoltageExponent" Comment from profile: Exponent of per unit voltage effecting real power. This model used only when "useExponentModel" is true.

energyConsumer

public java.util.List<EnergyConsumer> energyConsumer

Attribute "energyConsumer" Comment from profile: The set of loads that have the response characteristics.

qConstantPower

public float qConstantPower

Attribute "qConstantPower" Comment from profile: Portion of reactive power load modeled as constant power. Used only if the useExponentModel is false. This value is noralized against the sum of qZ, qI, and qP.

qConstantImpedance

public float qConstantImpedance

Attribute "qConstantImpedance" Comment from profile: Portion of reactive power load modeled as constant impedance. Used only if the useExponentModel is false. This value is noralized against the sum of qZ, qI, and qP.

exponentModel

public boolean exponentModel

Attribute "exponentModel" Comment from profile: Indicates the exponential voltage dependency model (pVoltateExponent and qVoltageExponent) is to be used. If false, the coeficient model (consisting of pConstantImpedance, pConstantCurrent, pConstantPower, qConstantImpedance, qConstantCurrent, and qConstantPower) is to be used.

pConstantImpedance

public float pConstantImpedance

Attribute "pConstantImpedance" Comment from profile: Portion of active power load modeled as constant impedance. Used only if the useExponentModel is false. This value is noralized against the sum of pZ, pI, and pP.

qVoltageExponent

public float qVoltageExponent

Attribute "qVoltageExponent" Comment from profile: Exponent of per unit voltage effecting reactive power. This model used only when "useExponentModel" is true.

qConstantCurrent

public float qConstantCurrent

Attribute "qConstantCurrent" Comment from profile: Portion of reactive power load modeled as constant current. Used only if the useExponentModel is false. This value is noralized against the sum of qZ, qI, and qP.

pConstantPower

public float pConstantPower

Attribute "pConstantPower" Comment from profile: Portion of active power load modeled as constant power. Used only if the useExponentModel is false. This value is noralized against the sum of pZ, pI, and pP.

pConstantCurrent

public float pConstantCurrent

Attribute "pConstantCurrent" Comment from profile: Portion of active power load modeled as constant current. Used only if the useExponentModel is false. This value is noralized against the sum of pZ, pI, and pP.

Constructor Detail

LoadResponseCharacteristic

protected LoadResponseCharacteristic()

Constructor of the class LoadResponseCharacteristic

Method Detail

getPVoltageExponent

public float getPVoltageExponent()

Utility to return the "pVoltageExponent" value

Returns:

the value of the attribute "pVoltageExponent"

setPVoltageExponent

public void setPVoltageExponent(float pVoltageExponentValue)

Utility to set the "pVoltageExponent" value

Parameters:

pVoltageExponentValue - value to set

pVoltageExponentIsSet

public boolean pVoltageExponentIsSet()

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

Returns:

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

getEnergyConsumer

public java.util.List<EnergyConsumer> getEnergyConsumer()

Utility to return the "energyConsumer" List of "EnergyConsumer" enum

Returns:

the list of the attributes "energyConsumer"

addEnergyConsumer

public void addEnergyConsumer(EnergyConsumer energyConsumerValue,
                              boolean setInverse)
                       throws LinkageException

Utility to add a value within the "energyConsumer" ArrayList of "EnergyConsumer"

Parameters:

energyConsumerValue - value to add within the ArrayList

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

Throws:

LinkageException

energyConsumerIsSet

public boolean energyConsumerIsSet()

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

Returns:

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

getQConstantPower

public float getQConstantPower()

Utility to return the "qConstantPower" value

Returns:

the value of the attribute "qConstantPower"

setQConstantPower

public void setQConstantPower(float qConstantPowerValue)

Utility to set the "qConstantPower" value

Parameters:

qConstantPowerValue - value to set

qConstantPowerIsSet

public boolean qConstantPowerIsSet()

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

Returns:

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

getQConstantImpedance

public float getQConstantImpedance()

Utility to return the "qConstantImpedance" value

Returns:

the value of the attribute "qConstantImpedance"

setQConstantImpedance

public void setQConstantImpedance(float qConstantImpedanceValue)

Utility to set the "qConstantImpedance" value

Parameters:

qConstantImpedanceValue - value to set

qConstantImpedanceIsSet

public boolean qConstantImpedanceIsSet()

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

Returns:

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

isExponentModel

public boolean isExponentModel()

Utility to return the "exponentModel" value

Returns:

the value of the attribute "exponentModel"

setExponentModel

public void setExponentModel(boolean exponentModelValue)

Utility to set the "exponentModel" value

Parameters:

exponentModelValue - value to set

exponentModelIsSet

public boolean exponentModelIsSet()

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

Returns:

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

getPConstantImpedance

public float getPConstantImpedance()

Utility to return the "pConstantImpedance" value

Returns:

the value of the attribute "pConstantImpedance"

setPConstantImpedance

public void setPConstantImpedance(float pConstantImpedanceValue)

Utility to set the "pConstantImpedance" value

Parameters:

pConstantImpedanceValue - value to set

pConstantImpedanceIsSet

public boolean pConstantImpedanceIsSet()

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

Returns:

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

getQVoltageExponent

public float getQVoltageExponent()

Utility to return the "qVoltageExponent" value

Returns:

the value of the attribute "qVoltageExponent"

setQVoltageExponent

public void setQVoltageExponent(float qVoltageExponentValue)

Utility to set the "qVoltageExponent" value

Parameters:

qVoltageExponentValue - value to set

qVoltageExponentIsSet

public boolean qVoltageExponentIsSet()

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

Returns:

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

getQConstantCurrent

public float getQConstantCurrent()

Utility to return the "qConstantCurrent" value

Returns:

the value of the attribute "qConstantCurrent"

setQConstantCurrent

public void setQConstantCurrent(float qConstantCurrentValue)

Utility to set the "qConstantCurrent" value

Parameters:

qConstantCurrentValue - value to set

qConstantCurrentIsSet

public boolean qConstantCurrentIsSet()

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

Returns:

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

getPConstantPower

public float getPConstantPower()

Utility to return the "pConstantPower" value

Returns:

the value of the attribute "pConstantPower"

setPConstantPower

public void setPConstantPower(float pConstantPowerValue)

Utility to set the "pConstantPower" value

Parameters:

pConstantPowerValue - value to set

pConstantPowerIsSet

public boolean pConstantPowerIsSet()

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

Returns:

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

getPConstantCurrent

public float getPConstantCurrent()

Utility to return the "pConstantCurrent" value

Returns:

the value of the attribute "pConstantCurrent"

setPConstantCurrent

public void setPConstantCurrent(float pConstantCurrentValue)

Utility to set the "pConstantCurrent" value

Parameters:

pConstantCurrentValue - value to set

pConstantCurrentIsSet

public boolean pConstantCurrentIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class LoadResponseCharacteristic 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(LoadResponseCharacteristic otherLoadResponseCharacteristic)

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:

otherLoadResponseCharacteristic - 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 LoadResponseCharacteristic 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