SDS2 Parametric API
 All Classes Namespaces Functions Variables Pages
Classes | Functions | Variables
Rebar Namespace Reference

Classes

class  DeformedEndOp
 No documentation available. More...
class  EndOperation
 No documentation available. More...
class  EndOperationType
 No documentation available. More...
class  HookType
 No documentation available. More...
class  map_indexing_suite_ParameterMap_entry
 No documentation available. More...
class  ParameterLockType
 No documentation available. More...
class  ParameterMap
 No documentation available. More...
class  ParameterUseType
 No documentation available. More...
class  ParameterVarType
 No documentation available. More...
class  PlainEndOp
 No documentation available. More...
class  RebarCoating
 No documentation available. More...
class  RebarDefinition
 No documentation available. More...
class  RebarGrade
 No documentation available. More...
class  RebarParameter
 No documentation available. More...
class  RebarReferencePoint
 No documentation available. More...
class  RebarShapeTemplate
 No documentation available. More...
class  RebarShapeTransform
 No documentation available. More...
class  RebarStandard
 No documentation available. More...
class  RebarUsageType
 No documentation available. More...
class  ReferencePoint
 No documentation available. More...
class  ShapedRebarMaterial
 No documentation available. More...
class  StringVec
 No documentation available. More...
class  TerminatorEndOp
 No documentation available. More...
class  TerminatorType
 No documentation available. More...
class  ThreadedEndOp
 No documentation available. More...
class  ThreadType
 No documentation available. More...

Functions

def CheckRebarSetupAndWarn
def CreateBatchRebarFromLayout
def CreateRebarFromLayout
def DrawRebarDiagram
def FitShapedRebarToDowels
def GetAvailableRebarCoatingNames
def GetAvailableRebarCoatings
def GetAvailableRebarGradeNames
def GetAvailableRebarGrades
def GetFilteredRebarTemplateNamesByTag
def GetFilteredRebarTemplates
def GetHookAngleOptions
def GetNumPlacementPoints
def GetRebarTemplates
def GetRebarUsageList
def GetValidRebarStandardNames
def GetValidRebarStandards
def SelectDowelsForRebarShapeFit
def SelectTemplate

Variables

 BOTTOM = Rebar.ReferencePoint.BOTTOM
 BOTTOM_LEFT = Rebar.ReferencePoint.BOTTOM_LEFT
 BOTTOM_RIGHT = Rebar.ReferencePoint.BOTTOM_RIGHT
 CENTER = Rebar.ReferencePoint.CENTER
 DEFORMED = Rebar.EndOperationType.DEFORMED
 END_HOOK = Rebar.HookType.END_HOOK
 LEFT = Rebar.ReferencePoint.LEFT
 NONE = Rebar.HookType.NONE
 NPT = Rebar.ThreadType.NPT
 PLAIN = Rebar.EndOperationType.PLAIN
 RIGHT = Rebar.ReferencePoint.RIGHT
 ROUND = Rebar.TerminatorType.ROUND
 SEISMIC_STIRRUP_HOOK = Rebar.HookType.SEISMIC_STIRRUP_HOOK
 SQUARE = Rebar.TerminatorType.SQUARE
 STIRRUP_HOOK = Rebar.HookType.STIRRUP_HOOK
 TAPERED = Rebar.ThreadType.TAPERED
 TERMINATOR = Rebar.EndOperationType.TERMINATOR
 THREADED = Rebar.EndOperationType.THREADED
 TOP = Rebar.ReferencePoint.TOP
 TOP_LEFT = Rebar.ReferencePoint.TOP_LEFT
 TOP_RIGHT = Rebar.ReferencePoint.TOP_RIGHT

Function Documentation

def Rebar.CheckRebarSetupAndWarn (   checkTemplates,
  activity 
)
Returns
Instance of type bool
     Checks that all the necessary rebar setup information is present.
     Args:
       checkTemplates: whether to check that there are rebar shape templates.
       activity: the activity that is being performed (e.g. add CMU wall).
     Returns: True if all the necessary setup information is present and
     False otherwise.
 
     C++ signature :
         bool CheckRebarSetupAndWarn(bool,std::string)
def Rebar.CreateBatchRebarFromLayout (   layouts,
  xforms,
  defName,
  standardName,
  gradeName,
  coatingName,
  refPoint,
  usageType,
  usage 
)
Returns
Instance of type list
     Creates a rebar material from a Layout3D.
     Args:
     layouts: The Layout3Ds from which to build the rebar shapes.
     xforms: The transforms for the layouts.
     defName: the size designation of the rebar definition (e.g. #3).
     standardName: the description of the rebar standard.
     gradeName: the description of the rebar steel grade.
     coatingName: the description of the rebar coating.
     refPoint: the reference point location.
     usageType: the usage (function) type.
     usage: the usage (function) of the rebar.
     
 
     C++ signature :
         boost::python::list CreateBatchRebarFromLayout(boost::python::list {lvalue},boost::python::list {lvalue},std::string,std::string,std::string,std::string,ShapedRebarMaterial::ReferencePoint,Rebar::RebarUsageType,std::string)
def Rebar.CreateRebarFromLayout (   layout,
  defName,
  standardName,
  gradeName,
  coatingName,
  refPoint,
  submaterial_to_global,
  schedule_group,
  mat,
  layer,
  usage 
)
Returns
Instance of type ShapedRebarMaterial
     Creates a rebar material from a Layout3D.
     Args:
     layout: The Layout3D from which to build a rebar shape consisting
       of segments connected by bends.  The layout must contain at least
       two vertices. The diameter of the
       bends in the rebar shape will be two times the radii at the given
       vertices.  The negative of the depth vector at the first vertex will
       be treated as the normal for the rebar shape.  The normal is used to
       determine how to adjust for the ReferencePoint (i.e. left/right/top/bottom).
       If the depth vector is not normal to the rebar shape then an error will be
       generated.
       Note: a layout with 3 or more points has two valid normals, and
       a layout with 2 points has infinitely many normals.
     defName: the size designation of the rebar definition (e.g. #3).
     standardName: the description of the rebar standard.
     gradeName: the description of the rebar steel grade.
     coatingName: the description of the rebar coating.
     refPoint: the reference point location.
     submaterial_to_global: the submaterial to global transformation.
     
 
     C++ signature :
         Alloy::Pointer::Pointer<ShapedRebarMaterial> CreateRebarFromLayout(Layout3D {lvalue},std::string,std::string,std::string,std::string,ShapedRebarMaterial::ReferencePoint [,Xform [,int [,int [,int [,std::string]]]]])
def Rebar.DrawRebarDiagram (   arg1,
  arg2 
)
Returns
Instance of type None
     C++ signature :
         void DrawRebarDiagram(Alloy::Pointer::Pointer<ShapedRebarMaterial>,boost::python::api::object)
def Rebar.FitShapedRebarToDowels (   templateName,
  defName,
  standardName,
  gradeName,
  coatingName,
  refPoint,
  dowels,
  showXform 
)
Returns
Instance of type ShapedRebarMaterial
     Attempts to fit a rebar shape to a set of dowels. This function assumes
     the dowels run orthogonal to the plane of the rebar shape.
     Args:
     shapeTemplate: the template for the rebar shape.  The rebar shape
       is expected to have all of its placement points on hooks or bends so they
       can wrap around the dowels.
     rebarDef: the definition for the type of rebar to use.
     standardName: the description of the rebar standard.
     gradeName: the description of the rebar steel grade.
     coatingName: the description of the rebar coating.
     refPoint: the rebar material reference point.
     dowels: information about the dowels that the shape should be fitted
       to.  Each dowel is represented by a pair with the first element being the
       location of the dowel and the second element being its diameter.  The
       number of dowels must be equal to the number of placement points defined
       for the rebar shape or one less.  If the number of dowels is one less then
       the final placement point will wrap back to the first dowel.  The locations
       of the dowels must all be on an X-Y plane. The locations are assumed to be
       in local coordinates.
     showXform: the view transform.  When applied to the dowel locations they are   transformed to global coordinates.
     Returns a shaped rebar material that is fit to the dowels as close as
     possible.
     
 
     C++ signature :
         Alloy::Pointer::Pointer<ShapedRebarMaterial> FitShapedRebarToDowels(std::string,std::string,std::string,std::string,std::string,ShapedRebarMaterial::ReferencePoint,boost::python::api::object,Xform)
def Rebar.GetAvailableRebarCoatingNames (   standardName)
Returns
Instance of type list
     Lists the descriptions for all available rebar coatings for the specified standard.
     Args:
     standardName: The name of the rebar standard for which to
         retrieve available coating names.
 
     C++ signature :
         boost::python::list GetAvailableRebarCoatingNames(std::string)
def Rebar.GetAvailableRebarCoatings (   standard)
Returns
Instance of type list
     Lists all available rebar coatings for the specified standard.
     Args:
     standard: The rebar standard for which to retrieve available coatings.
 
     C++ signature :
         boost::python::list GetAvailableRebarCoatings(sj_rebar_standard)
def Rebar.GetAvailableRebarGradeNames (   standardName)
Returns
Instance of type list
     Lists the descriptions for all available rebar grades for the specified standard.
     Args:
     standardName: The name of the rebar standard for which to
         retrieve available grade names.
 
     C++ signature :
         boost::python::list GetAvailableRebarGradeNames(std::string)
def Rebar.GetAvailableRebarGrades (   standard)
Returns
Instance of type list
     Lists all available rebar grades for the specified standard.
     Args:
     standard: The rebar standard for which to retrieve available grades.
 
     C++ signature :
         boost::python::list GetAvailableRebarGrades(sj_rebar_standard)
def Rebar.GetFilteredRebarTemplateNamesByTag (   arg1,
  arg2 
)
Returns
Instance of type object
     C++ signature :
         std::set<std::string, std::less<std::string>, std::allocator<std::string> > GetFilteredRebarTemplateNamesByTag(boost::python::list,boost::python::list)
def Rebar.GetFilteredRebarTemplates (   min,
  max,
  tag 
)
Returns
Instance of type list
     Lists the names of the rebar templates available in the job that 
     have a placement point count that is between min and max.
     Args:
     min: The minimum number of placement points allowed.
     max: The maximum number of placement points allowed.
     tag: A tag that must be associated with the rebar shape, or the  empty string to not filter by tag.
     Returns the list of rebar templates that satisfy the parameters.
 
     C++ signature :
         boost::python::list GetFilteredRebarTemplates(int,int,std::string)
def Rebar.GetHookAngleOptions (   arg1)
Returns
Instance of type list
     C++ signature :
         boost::python::list GetHookAngleOptions(Rebar::HookType)
def Rebar.GetNumPlacementPoints (   arg1)
Returns
Instance of type int
     C++ signature :
         int GetNumPlacementPoints(std::string)
def Rebar.GetRebarTemplates (   args)
Returns
Instance of type list
     Lists the names of the rebar templates available in the job.
 
     C++ signature :
         boost::python::list GetRebarTemplates()
def Rebar.GetRebarUsageList (   arg1)
Returns
Instance of type StringVec
     C++ signature :
         std::vector<std::string, std::allocator<std::string> > GetRebarUsageList(Rebar::RebarUsageType)
def Rebar.GetValidRebarStandardNames (   args)
Returns
Instance of type list
     Lists the descriptions for all valid rebar standards in the job.
 
     C++ signature :
         boost::python::list GetValidRebarStandardNames()
def Rebar.GetValidRebarStandards (   args)
Returns
Instance of type list
     Lists all valid rebar standards in the job.
 
     C++ signature :
         boost::python::list GetValidRebarStandards()
def Rebar.SelectDowelsForRebarShapeFit (   arg1,
  arg2 
)
Returns
Instance of type list
     C++ signature :
         boost::python::list SelectDowelsForRebarShapeFit(int,Xform)
def Rebar.SelectTemplate (   arg1)
Returns
Instance of type str
     C++ signature :
         std::string SelectTemplate(boost::python::list)

Variable Documentation

Rebar.BOTTOM = Rebar.ReferencePoint.BOTTOM
Rebar.BOTTOM_LEFT = Rebar.ReferencePoint.BOTTOM_LEFT
Rebar.BOTTOM_RIGHT = Rebar.ReferencePoint.BOTTOM_RIGHT
Rebar.CENTER = Rebar.ReferencePoint.CENTER
Rebar.DEFORMED = Rebar.EndOperationType.DEFORMED
Rebar.END_HOOK = Rebar.HookType.END_HOOK
Rebar.LEFT = Rebar.ReferencePoint.LEFT
Rebar.NONE = Rebar.HookType.NONE
Rebar.NPT = Rebar.ThreadType.NPT
Rebar.PLAIN = Rebar.EndOperationType.PLAIN
Rebar.RIGHT = Rebar.ReferencePoint.RIGHT
Rebar.ROUND = Rebar.TerminatorType.ROUND
Rebar.SEISMIC_STIRRUP_HOOK = Rebar.HookType.SEISMIC_STIRRUP_HOOK
Rebar.SQUARE = Rebar.TerminatorType.SQUARE
Rebar.STIRRUP_HOOK = Rebar.HookType.STIRRUP_HOOK
Rebar.TAPERED = Rebar.ThreadType.TAPERED
Rebar.TERMINATOR = Rebar.EndOperationType.TERMINATOR
Rebar.THREADED = Rebar.EndOperationType.THREADED
Rebar.TOP = Rebar.ReferencePoint.TOP
Rebar.TOP_LEFT = Rebar.ReferencePoint.TOP_LEFT
Rebar.TOP_RIGHT = Rebar.ReferencePoint.TOP_RIGHT