CGMES_3_0_0
Loading...
Searching...
No Matches
CIMPP::PhaseTapChangerLinear Class Reference

Describes a tap changer with a linear relation between the tap step and the phase angle difference across the transformer. This is a mathematical model that is an approximation of a real phase tap changer. The phase angle is computed as stepPhaseShiftIncrement times the tap position. The voltage magnitude of both sides is the same. More...

#include <PhaseTapChangerLinear.hpp>

Inheritance diagram for CIMPP::PhaseTapChangerLinear:
Collaboration diagram for CIMPP::PhaseTapChangerLinear:

Public Member Functions

const char * debugString () const override
const std::list< std::string > & getAttributeNames () const override
const std::string & getClassNamespaceUrl () const override
const std::string & getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfiles () const override
const CGMESProfile & getRecommendedProfile () const override
const std::list< CGMESProfile > & getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfilesIncludingAttributes () const override
void addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::TapChanger
const char * debugString () const override
const std::list< std::string > & getAttributeNames () const override
const std::string & getClassNamespaceUrl () const override
const std::string & getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfiles () const override
const CGMESProfile & getRecommendedProfile () const override
const std::list< CGMESProfile > & getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfilesIncludingAttributes () const override
void addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from BaseClass
void setRdfid (const std::string &id)
std::string getRdfid () const

Static Public Member Functions

static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::PhaseTapChanger
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::TapChanger
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::PowerSystemResource
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::IdentifiedObject
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from BaseClass
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const CIMPP::BaseClassDefiner declare ()

Public Attributes

CIMPP::AngleDegrees stepPhaseShiftIncrement
 Phase shift per step position. A positive value indicates a positive angle variation from the Terminal at the PowerTransformerEnd, where the TapChanger is located, into the transformer. The actual phase shift increment might be more accurately computed from the symmetrical or asymmetrical models or a tap step table lookup if those are available. Default: 0.0.
CIMPP::Reactance xMax
 The reactance depends on the tap position according to a u shaped curve. The maximum reactance (xMax) appears at the low and high tap positions. Depending on the u curve the attribute can be either higher or lower than PowerTransformerEnd.x. Default: 0.0.
CIMPP::Reactance xMin
 The reactance depends on the tap position according to a u shaped curve. The minimum reactance (xMin) appears at the mid tap position. PowerTransformerEnd.x shall be consistent with PhaseTapChangerLinear.xMin and PhaseTapChangerNonLinear.xMin. In case of inconsistency, PowerTransformerEnd.x shall be used. Default: 0.0.
Public Attributes inherited from CIMPP::PhaseTapChanger
CIMPP::TransformerEnd * TransformerEnd
 Transformer end to which this phase tap changer belongs. Default: nullptr.
Public Attributes inherited from CIMPP::TapChanger
CIMPP::SvTapStep * SvTapStep
 The tap step state associated with the tap changer. Default: nullptr.
CIMPP::TapChangerControl * TapChangerControl
 The regulating control scheme in which this tap changer participates. Default: nullptr.
std::list< CIMPP::TapSchedule * > TapSchedules
 A TapChanger can have TapSchedules. Default: {}.
CIMPP::Boolean controlEnabled
 Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: false.
CIMPP::Integer highStep
 Highest possible tap step position, advance from neutral. The attribute shall be greater than lowStep. Default: 0.
CIMPP::Integer lowStep
 Lowest possible tap step position, retard from neutral. Default: 0.
CIMPP::Boolean ltcFlag
 Specifies whether or not a TapChanger has load tap changing capabilities. Default: false.
CIMPP::Integer neutralStep
 The neutral tap step position for this winding. The attribute shall be equal to or greater than lowStep and equal or less than highStep. It is the step position where the voltage is neutralU when the other terminals of the transformer are at the ratedU. If there are other tap changers on the transformer those taps are kept constant at their neutralStep. Default: 0.
CIMPP::Voltage neutralU
 Voltage at which the winding operates at the neutral tap setting. It is the voltage at the terminal of the PowerTransformerEnd associated with the tap changer when all tap changers on the transformer are at their neutralStep position. Normally neutralU of the tap changer is the same as ratedU of the PowerTransformerEnd, but it can differ in special cases such as when the tapping mechanism is separate from the winding more common on lower voltage transformers. This attribute is not relevant for PhaseTapChangerAsymmetrical, PhaseTapChangerSymmetrical and PhaseTapChangerLinear. Default: 0.0.
CIMPP::Integer normalStep
 The tap step position used in normal network operation for this winding. For a Fixed tap changer indicates the current physical tap setting. The attribute shall be equal to or greater than lowStep and equal to or less than highStep. Default: 0.
CIMPP::Float step
 Tap changer position. Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables. The reasons for continuous value are to support study cases where no discrete tap changer has yet been designed, a solution where a narrow voltage band forces the tap step to oscillate or to accommodate for a continuous solution as input. The attribute shall be equal to or greater than lowStep and equal to or less than highStep. Default: 0.0.
Public Attributes inherited from CIMPP::PowerSystemResource
std::list< CIMPP::Control * > Controls
 The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator. Default: {}.
CIMPP::Location * Location
 Location of this power system resource. Default: nullptr.
std::list< CIMPP::Measurement * > Measurements
 The measurements associated with this power system resource. Default: {}.
Public Attributes inherited from CIMPP::IdentifiedObject
std::list< CIMPP::DiagramObject * > DiagramObjects
 The diagram objects that are associated with the domain object. Default: {}.
CIMPP::String description
 The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: "".
CIMPP::String energyIdentCodeEic
 The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. For details on EIC scheme please refer to ENTSO-E web site. Default: "".
CIMPP::String mRID
 Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: "".
CIMPP::String name
 The name is any free human readable and possibly non unique text naming the object. Default: "".
CIMPP::String shortName
 The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: "".

Static Public Attributes

static const char debugName [] = "PhaseTapChangerLinear"
Static Public Attributes inherited from CIMPP::PhaseTapChanger
static const char debugName [] = "PhaseTapChanger"
Static Public Attributes inherited from CIMPP::TapChanger
static const char debugName [] = "TapChanger"
Static Public Attributes inherited from CIMPP::PowerSystemResource
static const char debugName [] = "PowerSystemResource"
Static Public Attributes inherited from CIMPP::IdentifiedObject
static const char debugName [] = "IdentifiedObject"
Static Public Attributes inherited from BaseClass
static const char debugName [] = "BaseClass"

Protected Member Functions

std::map< std::string, AttrDetails > allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::TapChanger
std::map< std::string, AttrDetails > allAttrDetailsMap () const override

Detailed Description

Describes a tap changer with a linear relation between the tap step and the phase angle difference across the transformer. This is a mathematical model that is an approximation of a real phase tap changer. The phase angle is computed as stepPhaseShiftIncrement times the tap position. The voltage magnitude of both sides is the same.

Member Function Documentation

◆ addClassGetFnsToMap()

void PhaseTapChangerLinear::addClassGetFnsToMap ( std::map< std::string, class_get_function > & get_map) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ addEnumGetFnsToMap()

void PhaseTapChangerLinear::addEnumGetFnsToMap ( std::map< std::string, get_function > & get_map) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ addPrimitiveGetFnsToMap()

void PhaseTapChangerLinear::addPrimitiveGetFnsToMap ( std::map< std::string, get_function > & get_map) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ allAttrDetailsMap()

std::map< std::string, AttrDetails > PhaseTapChangerLinear::allAttrDetailsMap ( ) const
overrideprotectedvirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ debugString()

const char * PhaseTapChangerLinear::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getAttributeNames()

const std::list< std::string > & PhaseTapChangerLinear::getAttributeNames ( ) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getAttributeNamespaceUrl()

const std::string & PhaseTapChangerLinear::getAttributeNamespaceUrl ( const std::string & attrName) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getClassNamespaceUrl()

const std::string & PhaseTapChangerLinear::getClassNamespaceUrl ( ) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getPossibleAttributeProfiles()

const std::list< CGMESProfile > & PhaseTapChangerLinear::getPossibleAttributeProfiles ( const std::string & attrName) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getPossibleProfiles()

const std::list< CGMESProfile > & PhaseTapChangerLinear::getPossibleProfiles ( ) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & PhaseTapChangerLinear::getPossibleProfilesIncludingAttributes ( ) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ getRecommendedProfile()

const CGMESProfile & PhaseTapChangerLinear::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.

◆ isAssignableFrom()

bool PhaseTapChangerLinear::isAssignableFrom ( BaseClass * otherObject) const
overridevirtual

Reimplemented from CIMPP::PhaseTapChanger.


The documentation for this class was generated from the following files: