cim1.model

Class BaseVoltage

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.BaseVoltage

public class BaseVoltage
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "BaseVoltage.java" represents the class BaseVoltage extends IdentifiedObject + isDC 1..1 boolean + TopologicalNode 0..-1 TopologicalNode (inverseAssociation) + VoltageLevel 0..-1 VoltageLevel (inverseAssociation) + nominalVoltage 1..1 float + ConductingEquipment 0..-1 ConductingEquipment (inverseAssociation)

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<ConductingEquipment>	conductingEquipment Attribute "conductingEquipment" Comment from profile: Use association to ConductingEquipment only when there is no VoltageLevel container used.
boolean	isDC Attribute "isDC" Comment from profile: If true, this is a direct current base voltage and items assigned to this base voltage are also associated with a direct current capabilities.
float	nominalVoltage Attribute "nominalVoltage" Comment from profile: The PowerSystemResource's base voltage.
java.util.List<TopologicalNode>	topologicalNode Attribute "topologicalNode" Comment from profile: The topological nodes at the base voltage.
java.util.List<VoltageLevel>	voltageLevel Attribute "voltageLevel" Comment from profile: The VoltageLevels having this BaseVoltage.

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

Method Summary

Modifier and Type	Method and Description
void	addConductingEquipment(ConductingEquipment conductingEquipmentValue, boolean setInverse) Utility to add a value within the "conductingEquipment" ArrayList of "ConductingEquipment"
void	addTopologicalNode(TopologicalNode topologicalNodeValue, boolean setInverse) Utility to add a value within the "topologicalNode" ArrayList of "TopologicalNode"
void	addVoltageLevel(VoltageLevel voltageLevelValue, boolean setInverse) Utility to add a value within the "voltageLevel" ArrayList of "VoltageLevel"
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
BaseVoltage	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
boolean	conductingEquipmentIsSet() Utility to test if the value of "conductingEquipment" has been set
void	copyBase(BaseVoltage otherBaseVoltage) 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 BaseVoltage	create(java.lang.String id) Factory of the class
java.util.List<ConductingEquipment>	getConductingEquipment() Utility to return the "conductingEquipment" List of "ConductingEquipment" enum
float	getNominalVoltage() Utility to return the "nominalVoltage" value
java.util.List<TopologicalNode>	getTopologicalNode() Utility to return the "topologicalNode" List of "TopologicalNode" enum
java.util.List<VoltageLevel>	getVoltageLevel() Utility to return the "voltageLevel" List of "VoltageLevel" enum
boolean	isDC() Utility to return the "isDC" value
boolean	isDCIsSet() Utility to test if the value of "isDC" 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
boolean	nominalVoltageIsSet() Utility to test if the value of "nominalVoltage" 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	setIsDC(boolean isDCValue) Utility to set the "isDC" value
void	setNominalVoltage(float nominalVoltageValue) Utility to set the "nominalVoltage" value
boolean	topologicalNodeIsSet() Utility to test if the value of "topologicalNode" has been set
boolean	voltageLevelIsSet() Utility to test if the value of "voltageLevel" 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

isDC

public boolean isDC

Attribute "isDC" Comment from profile: If true, this is a direct current base voltage and items assigned to this base voltage are also associated with a direct current capabilities. False indicates alternating current.

topologicalNode

public java.util.List<TopologicalNode> topologicalNode

Attribute "topologicalNode" Comment from profile: The topological nodes at the base voltage.

voltageLevel

public java.util.List<VoltageLevel> voltageLevel

Attribute "voltageLevel" Comment from profile: The VoltageLevels having this BaseVoltage.

nominalVoltage

public float nominalVoltage

Attribute "nominalVoltage" Comment from profile: The PowerSystemResource's base voltage.

conductingEquipment

public java.util.List<ConductingEquipment> conductingEquipment

Attribute "conductingEquipment" Comment from profile: Use association to ConductingEquipment only when there is no VoltageLevel container used.

Constructor Detail

BaseVoltage

protected BaseVoltage()

Constructor of the class BaseVoltage

Method Detail

isDC

public boolean isDC()

Utility to return the "isDC" value

Returns:

the value of the attribute "isDC"

setIsDC

public void setIsDC(boolean isDCValue)

Utility to set the "isDC" value

Parameters:

isDCValue - value to set

isDCIsSet

public boolean isDCIsSet()

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

Returns:

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

getTopologicalNode

public java.util.List<TopologicalNode> getTopologicalNode()

Utility to return the "topologicalNode" List of "TopologicalNode" enum

Returns:

the list of the attributes "topologicalNode"

addTopologicalNode

public void addTopologicalNode(TopologicalNode topologicalNodeValue,
                               boolean setInverse)
                        throws LinkageException

Utility to add a value within the "topologicalNode" ArrayList of "TopologicalNode"

Parameters:

topologicalNodeValue - value to add within the ArrayList

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

Throws:

LinkageException

topologicalNodeIsSet

public boolean topologicalNodeIsSet()

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

Returns:

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

getVoltageLevel

public java.util.List<VoltageLevel> getVoltageLevel()

Utility to return the "voltageLevel" List of "VoltageLevel" enum

Returns:

the list of the attributes "voltageLevel"

addVoltageLevel

public void addVoltageLevel(VoltageLevel voltageLevelValue,
                            boolean setInverse)
                     throws LinkageException

Utility to add a value within the "voltageLevel" ArrayList of "VoltageLevel"

Parameters:

voltageLevelValue - value to add within the ArrayList

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

Throws:

LinkageException

voltageLevelIsSet

public boolean voltageLevelIsSet()

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

Returns:

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

getNominalVoltage

public float getNominalVoltage()

Utility to return the "nominalVoltage" value

Returns:

the value of the attribute "nominalVoltage"

setNominalVoltage

public void setNominalVoltage(float nominalVoltageValue)

Utility to set the "nominalVoltage" value

Parameters:

nominalVoltageValue - value to set

nominalVoltageIsSet

public boolean nominalVoltageIsSet()

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

Returns:

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

getConductingEquipment

public java.util.List<ConductingEquipment> getConductingEquipment()

Utility to return the "conductingEquipment" List of "ConductingEquipment" enum

Returns:

the list of the attributes "conductingEquipment"

addConductingEquipment

public void addConductingEquipment(ConductingEquipment conductingEquipmentValue,
                                   boolean setInverse)
                            throws LinkageException

Utility to add a value within the "conductingEquipment" ArrayList of "ConductingEquipment"

Parameters:

conductingEquipmentValue - value to add within the ArrayList

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

Throws:

LinkageException

conductingEquipmentIsSet

public boolean conductingEquipmentIsSet()

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

Returns:

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

create

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

Factory of the class

Parameters:

id - id of the class BaseVoltage 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(BaseVoltage otherBaseVoltage)

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:

otherBaseVoltage - 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 BaseVoltage 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