cim1.model

Class ControlAreaGeneratingUnit

java.lang.Object

cim1.model.CIMInstance

cim1.model.ControlAreaGeneratingUnit

public class ControlAreaGeneratingUnit
extends CIMInstance

This file has been automatically generated by CIMGateway Description : This class "ControlAreaGeneratingUnit.java" represents the class ControlAreaGeneratingUnit : CIMInstance + GeneratingUnit 1..1 GeneratingUnit + ControlArea 1..1 ControlArea

Field Summary

Fields

Modifier and Type	Field and Description
ControlArea	controlArea Attribute "controlArea" Comment from profile: The parent control area for the generating unit specifications.
GeneratingUnit	generatingUnit Attribute "generatingUnit" Comment from profile: The generating unit specified for this control area.
java.lang.String	idControlArea The id of the attribute "controlArea" This id is mainly used to resolve links after parsing an instance
java.lang.String	idGeneratingUnit The id of the attribute "generatingUnit" This id is mainly used to resolve links after parsing an instance

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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
ControlAreaGeneratingUnit	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
boolean	controlAreaIsSet() Utility to test if the value of "controlArea" has been set
void	copyBase(ControlAreaGeneratingUnit otherControlAreaGeneratingUnit) 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 ControlAreaGeneratingUnit	create(java.lang.String id) Factory of the class
boolean	generatingUnitIsSet() Utility to test if the value of "generatingUnit" has been set
ControlArea	getControlArea() Utility to return the "controlArea"
GeneratingUnit	getGeneratingUnit() Utility to return the "generatingUnit"
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
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
void	setControlArea(ControlArea controlAreaValue, boolean setInverse) Utility to set the "controlAreaValue"
void	setGeneratingUnit(GeneratingUnit generatingUnitValue, boolean setInverse) Utility to set the "generatingUnitValue"
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.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

generatingUnit

public GeneratingUnit generatingUnit

Attribute "generatingUnit" Comment from profile: The generating unit specified for this control area. Note that a control area should include a GeneratingUnit only once.

idGeneratingUnit

public java.lang.String idGeneratingUnit

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

controlArea

public ControlArea controlArea

Attribute "controlArea" Comment from profile: The parent control area for the generating unit specifications.

idControlArea

public java.lang.String idControlArea

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

Constructor Detail

ControlAreaGeneratingUnit

protected ControlAreaGeneratingUnit()

Constructor of the class ControlAreaGeneratingUnit

Method Detail

getGeneratingUnit

public GeneratingUnit getGeneratingUnit()

Utility to return the "generatingUnit"

Returns:

the value of the attribute "generatingUnit"

generatingUnitIsSet

public boolean generatingUnitIsSet()

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

Returns:

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

setGeneratingUnit

public void setGeneratingUnit(GeneratingUnit generatingUnitValue,
                              boolean setInverse)
                       throws LinkageException

Utility to set the "generatingUnitValue"

Parameters:

generatingUnitValue - instance to set

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

Throws:

LinkageException

getControlArea

public ControlArea getControlArea()

Utility to return the "controlArea"

Returns:

the value of the attribute "controlArea"

controlAreaIsSet

public boolean controlAreaIsSet()

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

Returns:

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

setControlArea

public void setControlArea(ControlArea controlAreaValue,
                           boolean setInverse)
                    throws LinkageException

Utility to set the "controlAreaValue"

Parameters:

controlAreaValue - instance to set

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

Throws:

LinkageException

create

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

Factory of the class

Parameters:

id - id of the class ControlAreaGeneratingUnit 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

Specified by:

clearContent in class CIMInstance

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

Specified by:

readAttribute in class CIMInstance

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

Specified by:

readResource in class CIMInstance

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

Specified by:

write in class CIMInstance

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

Specified by:

write in class CIMInstance

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

Specified by:

resolveLinks in class CIMInstance

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

Specified by:

modelConsistency in class CIMInstance

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

Specified by:

modelConsistency in class CIMInstance

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(ControlAreaGeneratingUnit otherControlAreaGeneratingUnit)

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:

otherControlAreaGeneratingUnit - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

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

Specified by:

clearAssociations in class CIMInstance

Parameters:

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

clone

public ControlAreaGeneratingUnit 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 java.lang.Object

Returns:

a clone of this instance